Add deploy environment header (Comfy-Env) to partner node API calls

[Kosinkadink]

Summary

Adds a Comfy-Env header to API requests sent to api.comfy.org, allowing the API to differentiate between environment types (e.g. local-git, local-desktop2-standalone).

Relates to Comfy-Org/ComfyUI-Desktop-2.0-Beta#416, paired with Comfy-Org/ComfyUI-Desktop-2.0-Beta#428.

How it works

1. A new module comfy/deploy_environment.py reads a .comfy_environment file from the ComfyUI install directory (resolved from this module's own path so --base-directory cannot redirect the lookup).
2. If the file exists, its first line is read (capped at 128 bytes), stripped of whitespace, and filtered to printable ASCII (32 <= ord(c) < 127) - this both sanitizes the value and prevents header-injection / CRLF-smuggling attacks.
3. If the file is absent or the sanitized value is empty, the value defaults to local-git.
4. The result is memoized via @functools.cache (one read per process; tests use cache_clear() for isolation).
5. The value is sent as a Comfy-Env header on relative-URL requests in comfy_api_nodes/util/client.py - the relative-URL gate ensures the header is only attached to api.comfy.org calls, never to third-party endpoints reached via custom hostnames.
6. The .comfy_environment file is gitignored so launchers/installers can write it without affecting the repository.

Naming convention

Values use dashes (local-git, local-desktop2-standalone) rather than underscores - easier to type and more conventional for HTTP-header-adjacent identifiers.

Usage

Launchers or installers write a .comfy_environment file in the ComfyUI install directory with the desired value:

local-desktop2-standalone

No CLI args or environment variables needed. Git clone users get local-git automatically.

Tests

New tests-unit/deploy_environment_test.py covers:

• missing-file fallback to local-git
• basic value read + whitespace stripping
• multi-line file (only first line used)
• empty file / whitespace-only file fallbacks
• control-char stripping (header-injection protection)
• non-ASCII stripping
• 128-byte read cap on a huge single-line file
• cache stickiness across calls
• OSError during read falls back to default

11 tests, all passing locally.

Manual verification

Deployed PR via comfy-runner to a local standalone installation and verified the header is sent correctly on partner node API calls (Gemini image generation via api.comfy.org).

Test 1 - Custom environment file:

• Created .comfy_environment with content standalone_test in the ComfyUI install directory
• Ran an API node workflow (Gemini image gen)
• Confirmed via debug logging that the outgoing request header was Comfy-Env: standalone_test ?

Test 2 - Default fallback (no file):

• Deleted the .comfy_environment file and restarted ComfyUI
• Ran the same API node workflow
• Confirmed the outgoing request header was Comfy-Env: local-git ?

API Node PR Checklist

Scope

• Is API Node Change

Pricing & Billing

• Need pricing update
• No pricing update

If Need pricing update:

• Metronome rate cards updated
• Auto-billing tests updated and passing

QA

• QA done
• QA not required

Comms

• Informed Kosinkadink

[coderabbitai]

Note

Reviews paused

It looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the reviews.auto_review.auto_pause_after_reviewed_commits setting.

Use the following commands to manage reviews:

• @coderabbitai resume to resume automatic reviews.
• @coderabbitai review to trigger a single review.

Use the checkboxes below for quick actions:

• ▶️ Resume reviews
• 🔍 Trigger review

📝 Walkthrough

Walkthrough

Adds .comfy_environment to .gitignore. Introduces comfy/deploy_environment.py with _DEFAULT_DEPLOY_ENV = "local_git", _ENV_FILENAME = ".comfy_environment", a module-level _cached_value, and get_deploy_environment() which reads the file’s first line (UTF-8, max 128 chars), strips whitespace, filters to printable ASCII, caches the result, and falls back to the default on missing or error conditions (logging non-FileNotFoundError exceptions). The HTTP client injects an X-Comfy-Env header for relative requests. Unit tests for these behaviors were added.

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Docstring Coverage	⚠️ Warning	Docstring coverage is 12.50% which is insufficient. The required threshold is 80.00%.	Write docstrings for the functions missing them to satisfy the coverage threshold.

✅ Passed checks (4 passed)

Check name	Status	Explanation
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Description check	✅ Passed	The PR description is detailed and directly addresses the changeset: it explains the new deploy environment feature, how it works, testing performed, and relates it to specific issues.
Title check	✅ Passed	The title directly reflects the main objective: adding an X-Comfy-Env header to API calls for partner nodes.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

Actionable comments posted: 2

🤖 Prompt for all review comments with AI agents

Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@comfy_api_nodes/util/client.py`:
- Around line 620-623: The X-Comfy-Env header is only being set inside the
"relative URL" branch, so absolute requests to the Comfy API host miss it;
update the logic so payload_headers["X-Comfy-Env"] is added whenever the request
targets the Comfy API host (either parsed_url has no scheme/netloc or
parsed_url.netloc matches cfg.endpoint.host or cfg.endpoint.netloc), not only
for relative URLs. Keep the existing get_auth_header(cfg.node_cls) behavior for
relative URLs but move or add the X-Comfy-Env assignment to run for both the
relative-URL branch and for absolute URLs whose netloc equals the configured
Comfy API endpoint (use parsed_url, payload_headers, cfg.endpoint to
locate/compare).

In `@comfy/deploy_environment.py`:
- Around line 21-25: The code reads env_file and caches its raw contents into
_cached_value which can contain newlines or control characters that will break
the X-Comfy-Env HTTP header; inside the with open(...) block (where env_file,
value and _cached_value are used) sanitize the value before caching by taking
only the first line (value.splitlines()[0] if any) and stripping it, then remove
any control/non-ASCII or non-printable characters (e.g. filter out chars with
ord() < 32 or ==127) so the resulting string is header-safe, and assign that
sanitized string to _cached_value before returning.

🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

• Push a commit to this branch (recommended)
• Create a new PR with the fixes

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 8f031b8d-8871-468e-a44f-985ac78a0163

📥 Commits

Reviewing files that changed from the base of the PR and between 1de83f9 and 4de0e4e.

📒 Files selected for processing (3)

• .gitignore
• comfy/deploy_environment.py
• comfy_api_nodes/util/client.py

[coderabbitai]

♻️ Duplicate comments (1)

comfy_api_nodes/util/client.py (1)

620-623: ⚠️ Potential issue | 🟠 Major

X-Comfy-Env is still not applied to absolute Comfy API URLs.

At Line 620, the header is gated by the relative-URL check, so absolute URLs targeting the same API host won’t include X-Comfy-Env. That leaves environment signaling incomplete versus the PR goal.

Suggested fix

-        if not parsed_url.scheme and not parsed_url.netloc:  # is URL relative?
-            payload_headers.update(get_auth_header(cfg.node_cls))
-            payload_headers["X-Comfy-Env"] = get_deploy_environment()
+        is_relative = not parsed_url.scheme and not parsed_url.netloc
+        if is_relative:  # relative URL uses default API host and auth
+            payload_headers.update(get_auth_header(cfg.node_cls))
+
+        base_netloc = urlparse(default_base_url()).netloc.lower()
+        target_netloc = parsed_url.netloc.lower() if parsed_url.netloc else base_netloc
+        if target_netloc == base_netloc:
+            payload_headers["X-Comfy-Env"] = get_deploy_environment()

🤖 Prompt for AI Agents

Verify each finding against the current code and only fix it if needed.

In `@comfy_api_nodes/util/client.py` around lines 620 - 623, The X-Comfy-Env
header is only added for relative URLs (parsed_url.scheme/netloc empty); change
the condition so X-Comfy-Env is also applied when the request targets the Comfy
API host even if an absolute URL is used: update the branch that sets
payload_headers (where parsed_url, payload_headers,
get_auth_header(cfg.node_cls) and get_deploy_environment() are used) to add
X-Comfy-Env when parsed_url.netloc is empty OR parsed_url.netloc equals the
Comfy API host (compare parsed_url.netloc against the configured base/API host
from cfg, e.g. urlparse(cfg.base_url or cfg.api_url).netloc), leaving other
header logic (cfg.endpoint.headers) intact.

🤖 Prompt for all review comments with AI agents

Verify each finding against the current code and only fix it if needed.

Duplicate comments:
In `@comfy_api_nodes/util/client.py`:
- Around line 620-623: The X-Comfy-Env header is only added for relative URLs
(parsed_url.scheme/netloc empty); change the condition so X-Comfy-Env is also
applied when the request targets the Comfy API host even if an absolute URL is
used: update the branch that sets payload_headers (where parsed_url,
payload_headers, get_auth_header(cfg.node_cls) and get_deploy_environment() are
used) to add X-Comfy-Env when parsed_url.netloc is empty OR parsed_url.netloc
equals the Comfy API host (compare parsed_url.netloc against the configured
base/API host from cfg, e.g. urlparse(cfg.base_url or cfg.api_url).netloc),
leaving other header logic (cfg.endpoint.headers) intact.

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 20aaffab-13c7-4d73-99e7-67dbe3edda7b

📥 Commits

Reviewing files that changed from the base of the PR and between 4de0e4e and d443728.

📒 Files selected for processing (3)

• .gitignore
• comfy/deploy_environment.py
• comfy_api_nodes/util/client.py

✅ Files skipped from review due to trivial changes (1)

• .gitignore

🚧 Files skipped from review as they are similar to previous changes (1)

• comfy/deploy_environment.py

[coderabbitai]

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents

Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@comfy/deploy_environment.py`:
- Around line 14-33: get_deploy_environment currently lazily sets the
module-level _cached_value without any synchronization, so concurrent callers
can race and a temporary read failure can permanently pin _DEFAULT_DEPLOY_ENV;
fix by introducing a module-level lock (e.g., threading.Lock) and surround the
check/read/set of _cached_value with the lock (use double-checked locking: check
_cached_value before acquiring and re-check after acquiring) so only one thread
performs the file open/read logic for _ENV_FILENAME and sets _cached_value
(falling back to _DEFAULT_DEPLOY_ENV on error) while keeping logger warning
behavior intact.

🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

• Push a commit to this branch (recommended)
• Create a new PR with the fixes

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: e3340ae7-563e-4db0-a340-61b02aa19c8d

📥 Commits

Reviewing files that changed from the base of the PR and between d443728 and e7fbb3c.

📒 Files selected for processing (3)

• .gitignore
• comfy/deploy_environment.py
• comfy_api_nodes/util/client.py

✅ Files skipped from review due to trivial changes (1)

• .gitignore

🚧 Files skipped from review as they are similar to previous changes (1)

• comfy_api_nodes/util/client.py

[guill]

One suggestion for a test to add, but no requests on actual functionality.

We should make sure this actually fulfills whatever purpose we're hoping to use it for. (E.g. if the goal is to see what percentage of Partner Node requests come from Desktop vs. git installs, we should make sure this header isn't going to get stripped by GCP ingest before it gets to us.)