Comfy-Org/desktop

Fork 0

mirror of https://github.com/Comfy-Org/desktop.git synced 2026-11-04 23:47:43 +00:00

) for one-click custom node installation with comprehensive testing #1419

New issue

Open

opened 2026-10-31 22:22:15 +00:00 by bsakaguchi · 0 comments

bsakaguchi commented

2026-10-31 22:22:15 +00:00

Owner

📋 Pull Request Information

Original PR: https://github.com/Comfy-Org/desktop/pull/1229
Author: @Copilot
Created: 7/23/2025
Status: 🔄 Open

Base: main ← Head: copilot/fix-1228

📝 Commits (7)

dee41da Initial plan
cb6a207 Implement core protocol handling infrastructure
2a5cfac Complete protocol implementation with ComfyUI Manager integration
9458c7f Add protocol implementation documentation
8a2a4f1 Add integration test for protocol URL handling with ComfyUI-AnimateDiff-Evolved
02278a2 Merge main into copilot/fix-1228 - resolve conflicts
da22cef Merge branch 'main' into copilot/fix-1228

📊 Changes

11 files changed (+989 additions, -52 deletions)

View changed files

📝 .gitignore (+3 -0)
➕ docs/PROTOCOL.md (+89 -0)
📝 src/constants.ts (+1 -0)
📝 src/desktopApp.ts (+199 -52)
📝 src/infrastructure/ipcChannels.ts (+6 -0)
📝 src/main.ts (+46 -0)
➕ src/protocol/protocolParser.ts (+99 -0)
➕ src/services/comfyManagerService.ts (+169 -0)
➕ tests/integration/post-install/protocolHandling.spec.ts (+162 -0)
➕ tests/unit/protocol/protocolParser.test.ts (+82 -0)
➕ tests/unit/services/comfyManagerService.test.ts (+133 -0)

📄 Description

This PR implements the comfy:// protocol handler for ComfyUI Desktop, enabling seamless one-click installation of custom nodes and workflows directly from web browsers.

Features

Protocol Actions

comfy://install-custom-node/<nodeId> - Install custom nodes via ComfyUI Manager
comfy://import/<resourceId> - Import workflows and resources

Example Usage

<!-- Web developers can now create one-click installation links -->
<a href="comfy://install-custom-node/ComfyUI-AnimateDiff-Evolved">
  Install in ComfyUI Desktop
</a>

<a href="comfy://import/my-workflow-123">
  Import Workflow
</a>

Implementation

Core Components

Protocol URL Parser (src/protocol/protocolParser.ts) - Robust parsing with comprehensive validation
ComfyUI Manager Service (src/services/comfyManagerService.ts) - HTTP API client for custom node operations
Protocol Registration (src/main.ts) - System-level protocol handler using Electron's app.setAsDefaultProtocolClient()
Action Queue System (src/desktopApp.ts) - Handles protocol URLs received before ComfyUI is ready

User Experience Flow

User clicks comfy:// link in browser
Browser prompts to launch ComfyUI Desktop
App launches and focuses window automatically
Protocol action is processed via ComfyUI Manager API
User receives feedback through logs and notifications

Technical Highlights

Single Instance Handling: Uses second-instance event for protocol URLs when app is already running
Action Queueing: Protocol actions are queued until ComfyUI server is fully ready
Error Handling: User-friendly error messages and comprehensive logging
Type Safety: Full TypeScript implementation with proper error types
Telemetry Integration: Usage tracking for analytics

Testing

Comprehensive Test Suite

16 unit tests total: 12 for protocol parsing + 4 for ComfyUI Manager service
3 integration tests for end-to-end protocol URL handling
Specific ComfyUI-AnimateDiff-Evolved testing as requested
Covers edge cases, malformed URLs, encoding, and error scenarios

Integration Tests

The integration tests launch ComfyUI Desktop with actual protocol URLs and verify:

Protocol URL reception and parsing
App startup with protocol arguments
Error handling for invalid protocol URLs
Custom TestApp class for protocol URL testing

Unit Test Coverage

Protocol URL parsing validation
ComfyManagerService method verification
Specific testing of comfy://install-custom-node/ComfyUI-AnimateDiff-Evolved
Spy verification that installation functions are called correctly

Security & Safety

Only predefined action types are supported (install-custom-node, import)
URL validation prevents malicious inputs
No arbitrary code execution possible from protocol URLs
Actions are safely queued and processed

Bundle Impact

Minimal size increase: ~6KB for complete functionality
No breaking changes to existing codebase
Full compatibility with current ComfyUI Desktop features

This enables the seamless browser-to-desktop workflow requested in the issue, allowing websites like the ComfyUI Registry to provide one-click installation buttons that launch ComfyUI Desktop and automatically install the selected custom nodes.

Fixes #1228.

💬 Share your feedback on Copilot coding agent for the chance to win a $200 gift card! Click here to start the survey.

_{🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.}

## 📋 Pull Request Information **Original PR:** https://github.com/Comfy-Org/desktop/pull/1229 **Author:** [@Copilot](https://github.com/apps/copilot-swe-agent) **Created:** 7/23/2025 **Status:** 🔄 Open **Base:** `main` ← **Head:** `copilot/fix-1228` --- ### 📝 Commits (7) - [`dee41da`](https://github.com/Comfy-Org/desktop/commit/dee41dafee9d1af69346c1e0cf3b740177bb9c1b) Initial plan - [`cb6a207`](https://github.com/Comfy-Org/desktop/commit/cb6a2079af412e55761749641693bbbd171bd0ca) Implement core protocol handling infrastructure - [`2a5cfac`](https://github.com/Comfy-Org/desktop/commit/2a5cfacac17fe1c0850483dc87c45110228e2084) Complete protocol implementation with ComfyUI Manager integration - [`9458c7f`](https://github.com/Comfy-Org/desktop/commit/9458c7f4faaf068c1c6c764f8e97b78b7aaeafe0) Add protocol implementation documentation - [`8a2a4f1`](https://github.com/Comfy-Org/desktop/commit/8a2a4f129bdce0eb37080a4cd843d6615886c4bd) Add integration test for protocol URL handling with ComfyUI-AnimateDiff-Evolved - [`02278a2`](https://github.com/Comfy-Org/desktop/commit/02278a211a63e8e3b672116e45c48a687441856b) Merge main into copilot/fix-1228 - resolve conflicts - [`da22cef`](https://github.com/Comfy-Org/desktop/commit/da22cefbba2d54271a31f1c8c247a1b684a465f1) Merge branch 'main' into copilot/fix-1228 ### 📊 Changes **11 files changed** (+989 additions, -52 deletions) <details> <summary>View changed files</summary> 📝 `.gitignore` (+3 -0) ➕ `docs/PROTOCOL.md` (+89 -0) 📝 `src/constants.ts` (+1 -0) 📝 `src/desktopApp.ts` (+199 -52) 📝 `src/infrastructure/ipcChannels.ts` (+6 -0) 📝 `src/main.ts` (+46 -0) ➕ `src/protocol/protocolParser.ts` (+99 -0) ➕ `src/services/comfyManagerService.ts` (+169 -0) ➕ `tests/integration/post-install/protocolHandling.spec.ts` (+162 -0) ➕ `tests/unit/protocol/protocolParser.test.ts` (+82 -0) ➕ `tests/unit/services/comfyManagerService.test.ts` (+133 -0) </details> ### 📄 Description This PR implements the `comfy://` protocol handler for ComfyUI Desktop, enabling seamless one-click installation of custom nodes and workflows directly from web browsers. ## Features ### Protocol Actions - **`comfy://install-custom-node/<nodeId>`** - Install custom nodes via ComfyUI Manager - **`comfy://import/<resourceId>`** - Import workflows and resources ### Example Usage ```html  <a href="comfy://install-custom-node/ComfyUI-AnimateDiff-Evolved"> Install in ComfyUI Desktop </a> <a href="comfy://import/my-workflow-123"> Import Workflow </a> ``` ## Implementation ### Core Components - **Protocol URL Parser** (`src/protocol/protocolParser.ts`) - Robust parsing with comprehensive validation - **ComfyUI Manager Service** (`src/services/comfyManagerService.ts`) - HTTP API client for custom node operations - **Protocol Registration** (`src/main.ts`) - System-level protocol handler using Electron's `app.setAsDefaultProtocolClient()` - **Action Queue System** (`src/desktopApp.ts`) - Handles protocol URLs received before ComfyUI is ready ### User Experience Flow 1. User clicks `comfy://` link in browser 2. Browser prompts to launch ComfyUI Desktop 3. App launches and focuses window automatically 4. Protocol action is processed via ComfyUI Manager API 5. User receives feedback through logs and notifications ### Technical Highlights - **Single Instance Handling**: Uses `second-instance` event for protocol URLs when app is already running - **Action Queueing**: Protocol actions are queued until ComfyUI server is fully ready - **Error Handling**: User-friendly error messages and comprehensive logging - **Type Safety**: Full TypeScript implementation with proper error types - **Telemetry Integration**: Usage tracking for analytics ## Testing ### Comprehensive Test Suite - **16 unit tests total**: 12 for protocol parsing + 4 for ComfyUI Manager service - **3 integration tests** for end-to-end protocol URL handling - **Specific ComfyUI-AnimateDiff-Evolved testing** as requested - Covers edge cases, malformed URLs, encoding, and error scenarios ### Integration Tests The integration tests launch ComfyUI Desktop with actual protocol URLs and verify: - Protocol URL reception and parsing - App startup with protocol arguments - Error handling for invalid protocol URLs - Custom TestApp class for protocol URL testing ### Unit Test Coverage - Protocol URL parsing validation - ComfyManagerService method verification - Specific testing of `comfy://install-custom-node/ComfyUI-AnimateDiff-Evolved` - Spy verification that installation functions are called correctly ## Security & Safety - Only predefined action types are supported (`install-custom-node`, `import`) - URL validation prevents malicious inputs - No arbitrary code execution possible from protocol URLs - Actions are safely queued and processed ## Bundle Impact - **Minimal size increase**: ~6KB for complete functionality - **No breaking changes** to existing codebase - **Full compatibility** with current ComfyUI Desktop features This enables the seamless browser-to-desktop workflow requested in the issue, allowing websites like the ComfyUI Registry to provide one-click installation buttons that launch ComfyUI Desktop and automatically install the selected custom nodes. Fixes #1228.  --- 💬 Share your feedback on Copilot coding agent for the chance to win a $200 gift card! Click [here](https://survey.alchemer.com/s3/8343779/Copilot-Coding-agent) to start the survey. --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>

bsakaguchi added the

pull-request

label

2026-10-31 22:22:15 +00:00

No milestone

No project

No assignees

1 participant

Notifications

Due date

The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference

Comfy-Org/desktop#1419

No description provided.

Rows
Columns